APIリファレンス：プロセス

プロセスを一覧表示

エンドポイント： GET /v1/tenant/{tenantId}/processes

認証： テナントスコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（200）：

プロセス一覧

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

エラー：

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

プロセスを作成（空のモデル）

エンドポイント： POST /v1/tenant/{tenantId}/processes

認証： テナントスコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid

リクエスト本文：

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}

フィールド	型	必須	説明
displayName	string	はい	プロセスツリーに表示するプロセス名 最大長：128
treeParentId	string	いいえ	親フォルダーID（null = 最上位） 形式：uuid
treeNodeType	Process | TreeGroup	いいえ	ProcessまたはTreeGroup（フォルダー） 許可される値：Process、TreeGroup デフォルト：Process

レスポンス（201）：

プロセスを作成しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
treeParentId	string	はい	形式：uuid
treeNodeType	Process | TreeGroup	はい	許可される値：Process、TreeGroup デフォルト：Process
displayName	string	はい	デフォルト：New Process 最大長：128
createdAt	string	はい	形式：date-time
updatedAt	string	はい	形式：date-time
designerModelId	string	はい	形式：uuid

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れです
• 500 予期しないサーバーエラー：安全に再試行できます

プロセスを取得

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}

認証： テナントスコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

レスポンス（200）：

プロセス

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
treeParentId	string	はい	形式：uuid
treeNodeType	Process | TreeGroup	はい	許可される値：Process、TreeGroup デフォルト：Process
displayName	string	はい	デフォルト：New Process 最大長：128
createdAt	string	はい	形式：date-time
updatedAt	string	はい	形式：date-time
designerModelId	string	はい	形式：uuid

エラー：

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

プロセスを更新

エンドポイント： PUT /v1/tenant/{tenantId}/processes/{processId}

認証： テナントスコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

リクエスト本文：

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
displayName	string	いいえ	プロセスツリーに表示するプロセス名 最大長：128
treeParentId	string	いいえ	親フォルダーID（null = 最上位） 形式：uuid

レスポンス（200）：

プロセスを更新しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
treeParentId	string	はい	形式：uuid
treeNodeType	Process | TreeGroup	はい	許可される値：Process、TreeGroup デフォルト：Process
displayName	string	はい	デフォルト：New Process 最大長：128
createdAt	string	はい	形式：date-time
updatedAt	string	はい	形式：date-time
designerModelId	string	はい	形式：uuid

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れです
• 404 リソースが見つかりません
• 500 予期しないサーバーエラー：安全に再試行できます

プロセスを論理削除

エンドポイント： DELETE /v1/tenant/{tenantId}/processes/{processId}

認証： テナントスコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

レスポンス（200）：

プロセスを削除しました

{
	"success": true,
	"message": "string"
}

フィールド	型	必須	説明
success	boolean	はい
message	string	はい

エラー：

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

プロセスモデルをBPMN 2.0 XMLとしてエクスポート

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

認証： テナントスコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

レスポンス（200）：

BPMN XML

{
	"bpmnXml": "string"
}

フィールド	型	必須	説明
bpmnXml	string	はい	BPMN 2.0 XML

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れです
• 404 リソースが見つかりません
• 500 予期しないサーバーエラー：安全に再試行できます

プロセスにBPMN 2.0モデルをインポート（現在のモデルを置き換え）

エンドポイント： PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

認証： テナントスコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

リクエスト本文：

{
	"bpmnXml": "string"
}

フィールド	型	必須	説明
bpmnXml	string	はい	BPMN 2.0 XML

レスポンス（200）：

BPMNをアップロードしました

{
	"message": "string"
}

フィールド	型	必須	説明
message	string	はい

エラー：

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

データマッピングはデータテーブルをプロセスに接続し、イベントログデータをプロセスモデル上で可視化・分析できるようにします。

プロセスのデータマッピングを一覧表示

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/mappings

認証： テナントスコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（200）：

マッピング一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

エラー：

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

データテーブルをプロセスにマッピング（イベントログの処理を開始）

エンドポイント： POST /v1/tenant/{tenantId}/processes/{processId}/mappings

認証： テナントスコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

フィールド	型	必須	説明
dataTableId	string	はい	プロセスにマッピングするデータテーブル 形式：uuid
displayName	string	いいえ	マッピングの表示名 最大長：128
color	object	いいえ	アクセントカラー
showByDefault	boolean	いいえ	プロセスビューでこのマッピングをデフォルト表示 デフォルト：true
mappingRole	primary | comparison	いいえ	モデル内でマッピングしたデータが担う役割 指定可能な値：primary、comparison

レスポンス（201）：

マッピングを作成しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
modelId	string	はい	形式：uuid
dataTableId	string	はい	形式：uuid
displayName	string	はい	最大長：128
color	object	はい
showByDefault	boolean	はい	デフォルト：true
mappingRole	primary | comparison	はい	指定可能な値：primary、comparison デフォルト：comparison
sortOrder	integer	はい	デフォルト：0 最小値：-9007199254740991 最大値：9007199254740991

エラー：

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

マッピングの更新

エンドポイント： PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
mappingId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

フィールド	型	必須	説明
displayName	string	いいえ	最大長：128
color	object	いいえ
showByDefault	boolean	いいえ
mappingRole	primary | comparison	いいえ	指定可能な値：primary、comparison
sortOrder	integer	いいえ	最小値：-9007199254740991 最大値：9007199254740991

レスポンス（200）：

マッピングを更新しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
modelId	string	はい	形式：uuid
dataTableId	string	はい	形式：uuid
displayName	string	はい	最大長：128
color	object	はい
showByDefault	boolean	はい	デフォルト：true
mappingRole	primary | comparison	はい	指定可能な値：primary、comparison デフォルト：comparison
sortOrder	integer	はい	デフォルト：0 最小値：-9007199254740991 最大値：9007199254740991

エラー：

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

マッピングの削除

エンドポイント： DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
mappingId	string	パス	はい	形式：uuid

レスポンス（200）：

マッピングを削除しました

{
	"success": true,
	"message": "string"
}

フィールド	型	必須	説明
success	boolean	はい
message	string	はい

エラー：

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

これらのエンドポイントでは、AIを使って自然言語の説明からBPMNプロセスモデルを自動作成します。

自然言語プロンプトからプロセスモデルを作成（非同期、ステータスエンドポイントをポーリング）

エンドポイント： POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

認証： テナント単位のAPIキー · write スコープ · レート制限2 req/s（バースト4）

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"prompt": "string"
}

フィールド	型	必須	説明
prompt	string	はい

レスポンス（200）：

作成を開始しました／結果

{
	"message": "string"
}

フィールド	型	必須	説明
message	string	はい

エラー：

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

モデル作成ステータスのポーリング

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

レスポンス（200）：

作成ステータス

{
	"message": "string"
}

フィールド	型	必須	説明
message	string	はい

エラー：

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

プロセスの最新モデルにおけるケース単位の指標です。計算されたシーケンスと健全性指標を、ケースごとに1行で返します。

プロセスのケース単位の指標を取得（最新モデル、ページング対応）

プロセスの最新モデルについて、計算されたプロセス指標（ケース期間、長さ、適合性チェック、手戻り、プロセス健全性スコア、バリアントなど）をケースごとに1行で返します。行のフィルタリングは適用されません。結果はページングされます。limit（デフォルト1000、最大10000）とoffsetを使用し、hasMoreがtrueの間はページングを続けてください。指標の計算中は、レスポンスのstateがpreprocessingになります。

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
limit	integer	クエリ	いいえ	返すケース行の最大数（デフォルト1000、最大10000）
offset	integer	クエリ	いいえ	スキップするケース行数（デフォルト0）

レスポンス（200）：

ケース指標

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

エラー：

• 400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
• 401 APIキーがない、無効、無効化済み、または期限切れ
• 404 リソースが見つかりません
• 503 データパイプラインの準備ができていないか、上流クエリに失敗しました

プロセスバージョンの一覧

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/versions

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（200）：

バージョン一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

エラー：

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

プロセスのバージョンスナップショットを作成

エンドポイント： POST /v1/tenant/{tenantId}/processes/{processId}/versions

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
displayName	string	いいえ	バージョンラベル デフォルト："" 最大長：128
description	string	いいえ	バージョンの任意の説明
versionType	manual | auto	いいえ	手動 = ユーザーが作成、自動 = システムが作成 許可される値：manual、auto
restoreFromVersionId	string	いいえ	このスナップショットの作成時に復元するバージョン 形式：uuid

レスポンス（201）：

バージョンを作成しました

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

フィールド	型	必須	説明
version	object	はい
restoredFrom	object	はい

エラー：

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

プロセスバージョンを取得

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
versionId	string	パス	はい	形式：uuid

レスポンス（200）：

バージョン

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

フィールド	型	必須	説明
version	object	はい

エラー：

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

プロセスバージョンの名前変更または更新

エンドポイント： PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
versionId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"displayName": "string",
	"description": "string"
}

フィールド	型	必須	説明
displayName	string	いいえ	バージョンラベル 最大長：128
description	string	いいえ	バージョンの任意の説明

レスポンス（200）：

バージョンを更新しました

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

フィールド	型	必須	説明
version	object	はい

エラー：

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

プロセスバージョンを削除

エンドポイント： DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
versionId	string	パス	はい	形式：uuid

レスポンス（200）：

バージョンを削除しました

{
	"deleted": true
}

フィールド	型	必須	説明
deleted	boolean	はい

エラー：

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

アーティファクトを取得

エンドポイント： GET /v1/tenant/{tenantId}/artifacts/{artifactId}

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
artifactId	string	パス	はい	形式：uuid

レスポンス（200）：

アーティファクト

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
displayName	string	はい	デフォルト："" 最大長：500
description	string	はい	最大長：2000
originalFileName	string	はい	デフォルト："" 最大長：500
mimeType	string	はい	デフォルト："" 最大長：200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	はい	指定可能な値：Image、Pdf、Docx、Xlsx、Pptx、Text、Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	はい	指定可能な値：modelIcon、processArtifact、doc、orgDoc、levelFrontPageImage デフォルト：modelIcon
uploadState	Uploading | Ready | Failed | Deleted	はい	指定可能な値：Uploading、Ready、Failed、Deleted デフォルト：Uploading
hasThumbnail	boolean	はい	デフォルト：false
sizeBytes	number	はい	デフォルト：0
createdAt	string	はい	形式：date-time
createdBy	string	いいえ	形式：uuid

エラー：

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

アーティファクトの表示名または説明を更新

エンドポイント： PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
artifactId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"displayName": "string",
	"description": "string"
}

フィールド	型	必須	説明
displayName	string	いいえ	アーティファクト名 最大長：500
description	string	いいえ	アーティファクトの任意の説明 最大長：2000

レスポンス（200）：

アーティファクトを更新しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
displayName	string	はい	デフォルト："" 最大長：500
description	string	はい	最大長：2000
originalFileName	string	はい	デフォルト："" 最大長：500
mimeType	string	はい	デフォルト："" 最大長：200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	はい	指定可能な値：Image、Pdf、Docx、Xlsx、Pptx、Text、Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	はい	指定可能な値：modelIcon、processArtifact、doc、orgDoc、levelFrontPageImage デフォルト：modelIcon
uploadState	Uploading | Ready | Failed | Deleted	はい	指定可能な値：Uploading、Ready、Failed、Deleted デフォルト：Uploading
hasThumbnail	boolean	はい	デフォルト：false
sizeBytes	number	はい	デフォルト：0
createdAt	string	はい	形式：date-time
createdBy	string	いいえ	形式：uuid

エラー：

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

アーティファクトを削除

エンドポイント： DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
artifactId	string	パス	はい	形式：uuid

レスポンス（200）：

アーティファクトを削除しました

{
	"deleted": true
}

フィールド	型	必須	説明
deleted	boolean	はい

エラー：

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

アーティファクトをダウンロードするため、署名付きURLへリダイレクト

エンドポイント： GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
artifactId	string	パス	はい	形式：uuid

エラー：

• 302 署名付きダウンロードURLへリダイレクト
• 401 APIキーがない、無効、無効化済み、または期限切れ
• 404 リソースが見つかりません

プロセスに添付されたアーティファクトの一覧

エンドポイント： GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

認証： テナント単位のAPIキー · read スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（200）：

プロセスアーティファクト一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

エラー：

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

新しいプロセスアーティファクト用の署名付きS3アップロードURLを取得

エンドポイント： POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

認証： テナント単位のAPIキー · write スコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
processId	string	パス	はい	形式：uuid

リクエストボディ：

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

フィールド	型	必須	説明
fileName	string	はい
mimeType	string	はい
sizeBytes	number	はい
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	いいえ	指定可能な値：modelIcon、processArtifact、doc、levelFrontPageImage デフォルト：processArtifact

レスポンス（200）：

署名付きアップロードURL

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

フィールド	型	必須	説明
artifactId	string	はい	形式：uuid
originalUrl	string	はい
thumbnailUrl	string	はい

エラー：

• 400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
• 401 APIキーがない、無効、無効化済み、または期限切れ
• 403 APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが無効、またはプランでファイル形式が制限されています
• 404 リソースが見つかりません
• 409 現在の状態とリクエストが競合しています（シート数の制限やIDの再利用など）