ドキュメント一覧

このページの内容

APIリファレンス：データ

Datasetエンドポイント

Datasetは、関連するDatatableをまとめた論理的なデータの集合です。

Dataset一覧取得

テナント内の全Datasetを取得します。

Endpoint: GET /tenant/{tenantId}/datasets

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID

Response:

[
	{
		"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"displayName": "Sales Data",
		"createdAt": "2024-01-20T08:00:00Z",
		"datatableCount": 3
	}
]

Dataset作成

テナント内に新しいDatasetを作成します。

Endpoint: POST /tenant/{tenantId}/datasets

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID

Request Body:

{
	"displayName": "My New Dataset",
	"treeNodeType": "Dataset",
	"treeParentId": null
}

Field	Type	Required	Description
displayName	string	Yes	Dataset名
treeNodeType	string	No	`Dataset` (デフォルト) または `TreeGroup`
treeParentId	string	No	Dataset整理用フォルダID

Response: 作成したDatasetオブジェクトを返します。

Dataset取得

指定のDataset詳細を取得します。

Endpoint: GET /tenant/{tenantId}/datasets/{datasetId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID
datasetId	string	path	Yes	Datasetの一意ID

Response:

{
	"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
	"displayName": "Sales Data",
	"createdAt": "2024-01-20T08:00:00Z",
	"datatables": [
		{
			"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
			"displayName": "Orders",
			"rowCount": 15000
		}
	]
}

Dataset削除

Datasetと、その中の全てのDatatableを削除します。

Endpoint: DELETE /tenant/{tenantId}/datasets/{datasetId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID
datasetId	string	path	Yes	Datasetの一意ID

Response:

{
	"success": true
}

warning

Datasetを削除すると、関連する全Datatableとデータが完全に消去されます。この操作は元に戻せません。

Datatableエンドポイント

DatatableはProcess Miningで利用するevent logデータを格納します。

Datatable一覧取得

テナントに存在する全Datatableを取得します。

Endpoint: GET /tenant/{tenantId}/datatables

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID

Response:

[
	{
		"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Orders 2024",
		"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"rowCount": 15000,
		"createdAt": "2024-01-25T10:00:00Z"
	}
]

Datatable作成

既存のDataset内に新しいDatatableを作成します。

Endpoint: POST /tenant/{tenantId}/datasets/{datasetId}/datatables

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID
datasetId	string	path	Yes	Datasetの一意ID

Request Body:

{
	"displayName": "Orders Q1 2024"
}

Field	Type	Required	Description
displayName	string	Yes	Datatable名

Response: 作成したDatatableオブジェクトを返します。

Datatable取得

指定のDatatable情報を取得します。

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID
datatableId	string	path	Yes	Datatableの一意ID

Response:

{
	"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Orders 2024",
	"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
	"rowCount": 15000,
	"columns": [
		{"name": "case_id", "type": "string"},
		{"name": "activity", "type": "string"},
		{"name": "timestamp", "type": "datetime"}
	],
	"createdAt": "2024-01-25T10:00:00Z"
}

PresignedアップロードURL取得

Datatableへの直アップロード用の一時URLを取得します。

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	テナントの一意ID
datatableId	string	path	Yes	Datatableの一意ID
datasetid	string	query	Yes	Datasetの一意ID
filename	string	query	Yes	アップロードするファイル名
filesize	string	query	Yes	ファイルサイズ（バイト単位）
filelastmodified	string	query	Yes	ファイルの最終更新時刻（timestamp）
validforseconds	string	query	No	URL有効時間（秒、デフォルト3600）

Response:

{
	"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
}

Usage: 返されたURLでHTTP PUTアップロードします：

# 必要なパラメータでPresigned URLを取得
URL=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")

# ファイルをアップロード
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

info

Presigned URLには有効期限があります。取得後はすぐに使ってください。アップロード失敗時は、新しいPresigned URLを再取得してください。