APIリファレンス: プロセス管理とマッピング

プロセスエンドポイント

プロセス一覧

テナント内の全プロセスを取得します。

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

パラメーター:

レスポンス:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

プロセス作成

テナント内に新しいプロセスを作成します。

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

パラメーター:

リクエストボディ:

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

レスポンス: 作成されたプロセスオブジェクトを返します。

プロセス取得

特定のプロセスの詳細情報を取得します。

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

パラメーター:

レスポンス:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

プロセス更新

プロセス名の変更や別フォルダへの移動ができます。

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

パラメーター:

リクエストボディ:

{
	"displayName": "Updated Process Name",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

レスポンス: 更新されたプロセスオブジェクトを返します。

プロセス削除

プロセスと関連データを削除します。

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

パラメーター:

レスポンス:

{
	"success": true
}

BPMNアップロード

BPMN XMLファイルをアップロードしてプロセスモデルを定義または更新します。

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

パラメーター:

リクエストボディ:

{
	"bpmnXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

レスポンス: 新しいモデル反映済みのプロセスオブジェクトを返します。

プロセスデータマッピングエンドポイント

data mappingはdatatableとプロセスを接続し、event logデータをプロセスモデル上で可視化・分析できます。

プロセスマッピング一覧

プロセスの全てのdata mappingを取得します。

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

パラメーター:

レスポンス:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

プロセスマッピング作成

プロセスにdatatableのmappingを追加します。

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

パラメーター:

リクエストボディ:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}

レスポンス: 作成されたmappingオブジェクトを返します。

プロセスマッピング更新

既存data mappingの表示設定を更新します。

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

パラメーター:

リクエストボディ:

{
	"displayName": "Updated Name",
	"color": { "id": "data-2" },
	"showByDefault": false
}

レスポンス: 更新されたmappingオブジェクトを返します。

プロセスマッピング削除

プロセスからdata mappingを削除します。

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

パラメーター:

レスポンス:

{
	"success": true
}