APIリファレンス:組織
組織管理とユーザー管理のエンドポイントに関する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}をポーリングし、hasDataLoadedがtrueになるまで確認してください。
データセットは、論理的に関連するデータテーブルをまとめたものです。
エンドポイント: 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"
}
] エラー:
エンドポイント: 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 | いいえ | データセットまたはフォルダー 指定可能な値: Dataset、TreeGroupデフォルト: 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 | はい | 指定可能な値:Dataset、TreeGroupデフォルト: Dataset |
| displayName | string | はい | デフォルト:""最大長:128 |
| createdAt | string | はい | 形式:date-time |
| updatedAt | string | はい | 形式:date-time |
| dataTableId | string | はい | 形式:uuid |
エラー:
エンドポイント: GET /v1/tenant/{tenantId}/datasets/{datasetId}
認証: テナントスコープのAPIキー · readスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| datasetId | string | パス | はい | 形式: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 | はい | 指定可能な値:Dataset、TreeGroupデフォルト: Dataset |
| displayName | string | はい | デフォルト:""最大長:128 |
| createdAt | string | はい | 形式:date-time |
| updatedAt | string | はい | 形式:date-time |
| dataTableId | string | はい | 形式:uuid |
エラー:
エンドポイント: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| datasetId | string | パス | はい | 形式:uuid |
レスポンス(200):
データセットを削除しました
{
"success": true,
"message": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| success | boolean | はい | |
| message | string | はい |
エラー:
エンドポイント: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
認証: テナントスコープのAPIキー · readスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| datasetId | string | パス | はい | 形式:uuid |
| limit | integer | クエリ | いいえ | 返す項目の最大数 |
| offset | integer | クエリ | いいえ | スキップする項目数 |
レスポンス(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"
}
}
] エラー:
エンドポイント: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| datasetId | string | パス | はい | 形式: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 | はい |
エラー:
データテーブルには、プロセスマイニングで使用するイベントログの実データが保存されます。
エンドポイント: GET /v1/tenant/{tenantId}/datatables
認証: テナントスコープのAPIキー · readスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| limit | integer | クエリ | いいえ | 返す項目の最大数 |
| offset | integer | クエリ | いいえ | スキップする項目数 |
レスポンス(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"
}
}
] エラー:
エンドポイント: GET /v1/tenant/{tenantId}/datatables/{dataTableId}
認証: テナントスコープのAPIキー · readスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式: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 | はい |
エラー:
エンドポイント: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式: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 | はい |
エラー:
エンドポイント: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download
認証: テナントスコープのAPIキー · readスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式:uuid |
レスポンス(200):
ダウンロードURL
{
"downloadUrl": "string",
"expiresInSeconds": 0
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| downloadUrl | string | はい | |
| expiresInSeconds | number | はい |
エラー:
APIキーにuploadDataスコープが必要です。
エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式:uuid |
リクエストボディ:
{
"uploadId": "string",
"uploadHandle": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| uploadId | string | はい | |
| uploadHandle | string | はい | 開始処理で返される不透明なハンドル |
レスポンス(200):
中止しました
{
"message": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| message | string | はい |
エラー:
APIキーにuploadDataスコープが必要です。アップロードされたパートをETagを使って結合し、イベントログの処理を開始します。
エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式:uuid |
リクエストボディ:
{
"uploadId": "string",
"uploadHandle": "string",
"parts": [
{
"partNumber": 0,
"eTag": "string"
}
]
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| uploadId | string | はい | |
| uploadHandle | string | はい | 開始処理で返される不透明なハンドル |
| parts | object[] | はい |
レスポンス(200):
完了({ completed: true })
{
"message": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| message | string | はい |
エラー:
APIキーにuploadDataスコープが必要です。uploadIdと不透明なuploadHandleを返します。これらは後続のparts、complete、abortの呼び出しに渡します。大容量ファイルに適しています。
エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式: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 | いいえ |
エラー:
APIキーにuploadDataスコープが必要です。指定された各パート番号に対して、署名付きPUT URLを1つずつ返します。
エンドポイント: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts
認証: テナントスコープのAPIキー · writeスコープ
パラメーター:
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | 形式:uuid |
| dataTableId | string | パス | はい | 形式:uuid |
リクエストボディ:
{
"uploadId": "string",
"uploadHandle": "string",
"partNumbers": [
0
]
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| uploadId | string | はい | |
| uploadHandle | string | はい | 開始処理で返される不透明なハンドル |
| partNumbers | number[] | はい |
レスポンス(200):
パート用署名付きURL({ uploadId, parts: [{ partNumber, url }] })
{
"message": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| message | string | はい |
エラー:
APIキーにuploadDataスコープが必要です(読み取り/書き込み権限とは別に確認されます)。申告された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 | いいえ | 使用可能な値:true、false |
| partnumber | string | query | いいえ | |
| validforseconds | integer | query | いいえ | 署名付きURLの有効期間(秒、1~3600、既定値:3600) |
レスポンス(200):
署名付きURL
{
"PreSignedUploadUrl": "string"
} | フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| PreSignedUploadUrl | string | はい | 署名付きS3 PUT URL(有効期間は約1時間) |
エラー:
クレジットカード不要、待ち時間なしですぐにご利用いただけます。組織の業務の進め方を、明確につながるプロセス設計として可視化します。
プロセスアーキテクチャを構築し、オーナーシップと統制を定め、あらゆる階層で役割と責任を明確にします。
無料トライアルを開始して、プロセスのガバナンス、管理、継続的な改善を支える信頼できる基盤を築きましょう。
Cookieを使用して、利便性の向上、コンテンツのパーソナライズ、トラフィックの分析を行っています。Cookieを使わずにページの閲覧状況を匿名で計測しています。「Accept All」をクリックすると、Cookieの使用に同意したことになります。