このページの内容

APIリファレンス:データ

warning

データセットを削除すると、関連するすべてのデータテーブルとデータが完全に削除されます。この操作は元に戻せません。

使用方法:

# Get the presigned URL with required parameters
URL=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{datatableId}/uploads/presigned-url?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the file
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

info

署名付きURLには有効期限があります。取得後は速やかに使用してください。アップロードに失敗した場合は、新しい署名付きURLをリクエストしてください。

使用方法:

# Get the download URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/download")

# Extract URL and download the file
DOWNLOAD_URL=$(echo $RESPONSE | jq -r '.downloadUrl')
curl -o "data.csv" "$DOWNLOAD_URL"

info

アップロードしたデータテーブルでは、元のファイル形式(CSV、Parquet、ORC、JSONL、Excel)が保持されます。シミュレーション結果のファイル形式は常にCSVです。

使用方法:

# Get delta presigned URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url?delta=true&filename=delta.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the delta file
UPLOAD_URL=$(echo $RESPONSE | jq -r '.PreSignedUploadUrl')
curl -X PUT --upload-file "delta.csv" -H "Content-Type: text/csv" "$UPLOAD_URL"

info

差分アップロードを使用するには、データテーブルに初期データがすでに読み込まれている必要があります。差分ファイルは元のアップロードと同じ形式(たとえば、元のファイルがCSVならCSVの差分、ParquetならParquetの差分)で、同じ列構造を使用してください。ExcelとXESファイルは差分アップロードに対応していません。

info

署名付きURL経由でアップロードすると、ProcessMindが差分を自動的に処理し、元のデータと結合します。GET /datatables/{dataTableId}hasDataLoadedtrueになるまでポーリングすると、処理の完了を確認できます。

データセットは、論理的にまとめて扱う関連データテーブルの集合です。

データセットの一覧取得

エンドポイント: GET /v1/tenant/{tenantId}/datasets

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
limit integer query いいえ 返す項目の最大数
offset integer query いいえ スキップする項目数

レスポンス(200):

データセットの一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Dataset",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"dataTableId": "00000000-0000-0000-0000-000000000000"
	}
]

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです

データセットを作成(空のデータテーブル付き)

エンドポイント: POST /v1/tenant/{tenantId}/datasets

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid

リクエスト本文:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset"
}
フィールド 必須 説明
displayName string はい データツリーに表示されるデータセット名
最大長:128
treeParentId string いいえ 親フォルダーID(null = 最上位)
形式:uuid
treeNodeType Dataset | TreeGroup いいえ データセットまたはフォルダー
許可される値:DatasetTreeGroup
デフォルト:Dataset

レスポンス(201):

作成されたデータセット

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"dataTableId": "00000000-0000-0000-0000-000000000000"
}
フィールド 必須 説明
id string はい 形式:uuid
treeParentId string はい 形式:uuid
treeNodeType Dataset | TreeGroup はい 許可される値:DatasetTreeGroup
デフォルト:Dataset
displayName string はい デフォルト:""
最大長:128
createdAt string はい 形式:date-time
updatedAt string はい 形式:date-time
dataTableId string はい 形式:uuid

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです

データセットを取得

エンドポイント: GET /v1/tenant/{tenantId}/datasets/{datasetId}

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
datasetId string path はい 形式:uuid

レスポンス(200):

データセット

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"dataTableId": "00000000-0000-0000-0000-000000000000"
}
フィールド 必須 説明
id string はい 形式:uuid
treeParentId string はい 形式:uuid
treeNodeType Dataset | TreeGroup はい 許可される値:DatasetTreeGroup
デフォルト:Dataset
displayName string はい デフォルト:""
最大長:128
createdAt string はい 形式:date-time
updatedAt string はい 形式:date-time
dataTableId string はい 形式:uuid

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

データセットを論理削除

エンドポイント: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
datasetId string path はい 形式:uuid

レスポンス(200):

削除されたデータセット

{
	"success": true,
	"message": "string"
}
フィールド 必須 説明
success boolean はい
message string はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

データセットのデータテーブルを一覧表示

エンドポイント: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
datasetId string path はい 形式:uuid
limit integer query いいえ 返す項目の最大数
offset integer query いいえ スキップする項目数

レスポンス(200):

データセット内のデータテーブル一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

データセット内に空のデータテーブルを作成

エンドポイント: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
datasetId string path はい 形式:uuid

リクエスト本文:

{
	"displayName": "string"
}
フィールド 必須 説明
displayName string はい データテーブル名
最大長:128

レスポンス(201):

作成されたデータテーブル

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}
フィールド 必須 説明
id string はい 形式:uuid
datasetId string はい 形式:uuid
displayName string はい デフォルト:""
最大長:128
createdAt string はい 形式:date-time
updatedAt string はい 形式:date-time
hasDataLoaded boolean はい デフォルト:false
filterExpression string はい 最大長:4096
metaInfo object | object | object | object はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

データテーブルには、プロセスマイニングで使用する実際のイベントログデータが保存されます。

データテーブルの一覧取得

エンドポイント: GET /v1/tenant/{tenantId}/datatables

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
limit integer query いいえ 返す項目の最大数
offset integer query いいえ スキップする項目数

レスポンス(200):

データテーブルの一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです

データテーブルを取得

エンドポイント: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

レスポンス(200):

データテーブル

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}
フィールド 必須 説明
id string はい 形式:uuid
datasetId string はい 形式:uuid
displayName string はい デフォルト:""
最大長:128
createdAt string はい 形式:date-time
updatedAt string はい 形式:date-time
hasDataLoaded boolean はい デフォルト:false
filterExpression string はい 最大長:4096
metaInfo object | object | object | object はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

データテーブルを更新(displayName、parseSettings、…)

エンドポイント: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

リクエスト本文:

{
	"displayName": "string",
	"filterExpression": "string"
}
フィールド 必須 説明
displayName string いいえ データテーブル名
最大長:128
filterExpression string いいえ データに適用するフィルター式
最大長:4096

レスポンス(200):

更新されたデータテーブル

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}
フィールド 必須 説明
id string はい 形式:uuid
datasetId string はい 形式:uuid
displayName string はい デフォルト:""
最大長:128
createdAt string はい 形式:date-time
updatedAt string はい 形式:date-time
hasDataLoaded boolean はい デフォルト:false
filterExpression string はい 最大長:4096
metaInfo object | object | object | object はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

データテーブルのソースファイルをダウンロードする署名付きURLを取得

エンドポイント: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

レスポンス(200):

ダウンロードURL

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}
フィールド 必須 説明
downloadUrl string はい
expiresInSeconds number はい

エラー:

  • 400不正なリクエスト:無効なフィルター式、モデルのないプロセス、対応していないアップロード形式、必須フィールドの不足など
  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 404リソースが見つかりません

マルチパートアップロードを中止して、アップロード済みのパートを破棄

APIキーにはuploadDataスコープが必要です。

エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

リクエスト本文:

{
	"uploadId": "string",
	"uploadHandle": "string"
}
フィールド 必須 説明
uploadId string はい
uploadHandle string はい 開始処理で返される不透明なハンドル

レスポンス(200):

中止済み

{
	"message": "string"
}
フィールド 必須 説明
message string はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが無効、またはプランでファイル形式が許可されていません
  • 404リソースが見つかりません

マルチパートアップロードを完了(全3ステップの3)

APIキーにはuploadDataスコープが必要です。アップロード済みのパートをETagを使って組み立て、イベントログの処理を開始します。

エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

リクエスト本文:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}
フィールド 必須 説明
uploadId string はい
uploadHandle string はい 開始処理で返される不透明なハンドル
parts object[] はい

レスポンス(200):

完了({ completed: true })

{
	"message": "string"
}
フィールド 必須 説明
message string はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが無効、またはプランでファイル形式が許可されていません
  • 404リソースが見つかりません

イベントログデータのマルチパート(チャンク分割)アップロードを開始(全3ステップの1)

APIキーにはuploadDataスコープが必要です。uploadIdと、不透明なuploadHandleを返します。後続のpartscompleteabortの呼び出しに渡してください。大きなファイルに適しています。

エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

リクエスト本文:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}
フィールド 必須 説明
fileName string はい
fileSize number はい
fileLastModified number はい
partCount number いいえ 署名付きURLを作成するパート数(デフォルト10)
delta boolean いいえ 差分(増分)アップロードかどうか
datasetId string いいえ 形式:uuid
modelId string いいえ 形式:uuid

レスポンス(200):

開始されたアップロード

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}
フィールド 必須 説明
uploadId string いいえ
uploadHandle string いいえ パート、完了、中止の各ステップで使用する不透明なハンドル
partCount number いいえ
partSizeBytes number いいえ

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが無効、またはプランでファイル形式が許可されていません
  • 404リソースが見つかりません

マルチパートアップロードの各パート用署名付きURLを取得(全3ステップの2)

APIキーにはuploadDataスコープが必要です。指定した各パート番号に対して、1つの署名付きPUT URLを返します。

エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

**認証:**テナント単位のAPIキー・writeスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid

リクエスト本文:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}
フィールド 必須 説明
uploadId string はい
uploadHandle string はい 開始処理で返される不透明なハンドル
partNumbers number[] はい

レスポンス(200):

パート用署名付きURL({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}
フィールド 必須 説明
message string はい

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが無効、またはプランでファイル形式が許可されていません
  • 404リソースが見つかりません

イベントログデータ(CSV/XLSX、完全または差分)用の署名付きS3アップロードURLを取得

APIキーにはuploadDataスコープが必要です(read/writeとは別です)。宣言されたfilesize(バイト単位)がプランの最大アップロードサイズと照合され、ファイルが到着した時点で実際のオブジェクトサイズが再確認されます。

エンドポイント: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

**認証:**テナント単位のAPIキー・readスコープ

パラメーター:

名前 場所 必須 説明
tenantId string path はい 形式:uuid
dataTableId string path はい 形式:uuid
filename string query はい
filesize string query はい ファイルサイズ(バイト単位。プランの最大アップロードサイズと照合)
filelastmodified string query はい
datasetid string query いいえ 完全アップロード(差分ではないアップロード)では必須
modelid string query いいえ 形式:uuid
delta true | false query いいえ 許可される値:truefalse
partnumber string query いいえ
validforseconds integer query いいえ 署名付きURLの有効期間(秒)(1~3600、デフォルト3600)

レスポンス(200):

署名付きURL

{
	"PreSignedUploadUrl": "string"
}
フィールド 必須 説明
PreSignedUploadUrl string はい 署名付きS3 PUT URL(有効期間約1時間)

エラー:

  • 401APIキーがない、無効、無効化済み、または期限切れです
  • 403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが無効、またはプランでファイル形式が許可されていません
  • 404リソースが見つかりません
  • 413ファイルがプランの最大アップロードサイズを超えています