このページの内容

> リソース > ドキュメント > api > APIリファレンス：シミュレーション

APIリファレンス：シミュレーション

シミュレーションでは、プロセスモデルに対して仮説シナリオを実行できます。処理時間、リソースの割り当て、到着率を設定し、プロセスの動きを予測します。

プロセスのシミュレーション一覧を取得

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

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

パラメーター：

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

レスポンス（200）：

シミュレーション一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"datasetName": "string",
		"startTime": "2024-03-15T16:30:00Z",
		"endTime": "2024-03-15T16:30:00Z",
		"useWarmUp": true
	}
]

エラー：

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

シミュレーションを作成（IDを指定すると冪等に処理）

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

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

パラメーター：

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

リクエスト本文：

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}

フィールド	型	必須	説明
id	string	いいえ	冪等性を保った再試行に使用する任意のID（UUIDである必要があります）形式：`uuid`
displayName	string	いいえ	シミュレーション名デフォルト：`New Simulation`
datasetName	string	いいえ	シミュレーションの実行対象となるデータセット名
startTime	string	いいえ	シミュレーションの開始時刻形式：`date-time`
endTime	string	いいえ	シミュレーションの終了時刻形式：`date-time`
useWarmUp	boolean	いいえ	ウォームアップ期間を除外するかどうかデフォルト：`false`

レスポンス（201）：

シミュレーションを作成しました

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}

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

エラー：

400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポート対象外のアップロード形式、必須フィールドの不足など
401 APIキーがない、無効、無効化済み、または有効期限切れです
404 リソースが見つかりません
409 リクエストが現在の状態と競合しています（シート数の制限やIDの再利用など）

要素設定、属性、リソースを含むシミュレーションを取得

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

レスポンス（200）：

シミュレーションの詳細

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"datasetName": "string",
		"startTime": "2024-03-15T16:30:00Z",
		"endTime": "2024-03-15T16:30:00Z",
		"useWarmUp": true
	},
	"elementSettings": [
		{
			"simulationId": "00000000-0000-0000-0000-000000000000",
			"modelElementId": "00000000-0000-0000-0000-000000000000",
			"settings": {
				"processingTimeDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"processingTimeUnit": "seconds",
				"updateAttributeRules": [
					{
						"id": "string",
						"attributeId": "00000000-0000-0000-0000-000000000000",
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"newValue": "string",
						"isEnabled": true
					}
				],
				"requiredResources": [
					{
						"resourceId": "00000000-0000-0000-0000-000000000000",
						"amount": 0
					}
				],
				"caseStartsDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"caseStartsTimeUnit": "perTimeSlot",
				"capacityInterval": "perHour",
				"skipChanceDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"queueStrategy": "fifo",
				"chanceToTakeDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				]
			}
		}
	],
	"attributes": [
		{
			"id": "00000000-0000-0000-0000-000000000000",
			"simulationId": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"valueDistribution": {
				"type": "Number",
				"numberDistributions": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot",
						"id": "string",
						"isEnabled": true,
						"isDefault": true
					}
				],
				"textDistributions": [
					{
						"id": "string",
						"timeslot": {
							"periodicity": "Always"
						},
						"isEnabled": true,
						"isDefault": true,
						"mode": "list",
						"textValues": [
							{
								"id": "string",
								"value": "string",
								"chance": 0
							}
						]
					}
				]
			},
			"simulationAttributeType": "string"
		}
	],
	"resources": [
		{
			"id": "00000000-0000-0000-0000-000000000000",
			"simulationId": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"levelDistribution": [
				{
					"timeslot": {
						"periodicity": "Always"
					},
					"conditions": [
						{
							"type": "Values",
							"attribute": "string",
							"values": [
								"string"
							]
						}
					],
					"distribution": {
						"type": "Fixed",
						"value": 0
					},
					"timeUnit": "seconds",
					"rateUnit": "perTimeSlot"
				}
			],
			"attributeId": "00000000-0000-0000-0000-000000000000"
		}
	]
}

フィールド	型	必須	説明
simulation	object	はい	シミュレーションの概要
elementSettings	object[]	はい	要素ごとのシミュレーション設定
attributes	object[]	はい	シミュレーション対象の属性
resources	object[]	はい	リソースプール

エラー：

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

シミュレーションを更新（フィールドまたは要素設定）

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

リクエスト本文：

{
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true,
	"elementSettings": [
		{
			"modelElementId": "00000000-0000-0000-0000-000000000000",
			"settings": {
				"caseStartsDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				],
				"processingTimeDistribution": [
					{
						"timeslot": {
							"periodicity": "Always"
						},
						"conditions": [
							{
								"type": "Values",
								"attribute": "string",
								"values": [
									"string"
								]
							}
						],
						"distribution": {
							"type": "Fixed",
							"value": 0
						},
						"timeUnit": "seconds",
						"rateUnit": "perTimeSlot"
					}
				]
			}
		}
	]
}

フィールド	型	必須	説明
displayName	string	いいえ	シミュレーション名
datasetName	string	いいえ	シミュレーションの実行対象となるデータセット名
startTime	string	いいえ	シミュレーションの開始時刻形式：`date-time`
endTime	string	いいえ	シミュレーションの終了時刻形式：`date-time`
useWarmUp	boolean	いいえ	ウォームアップ期間を除外するかどうか
elementSettings	object[]	いいえ	要素ごとの設定の上書き

レスポンス（200）：

シミュレーションを更新しました

{
	"message": "string"
}

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

エラー：

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

シミュレーションを完全に削除

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

レスポンス（200）：

シミュレーションを削除しました

{
	"message": "string"
}

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

エラー：

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

これらのエンドポイントでは、プロセスモデルに基づいてAIがシミュレーション設定を自動作成します。

AIでシミュレーション設定を作成（非同期処理。ステータスエンドポイントをポーリング）

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

リクエスト本文：

{
	"processDescription": "string",
	"additionalContext": "string"
}

フィールド	型	必須	説明
processDescription	string	いいえ
additionalContext	string	いいえ

レスポンス（200）：

設定の作成を開始／結果

{
	"message": "string"
}

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

エラー：

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

シミュレーション設定の作成状況を確認

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

レスポンス（200）：

作成状況

{
	"message": "string"
}

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

エラー：

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

シミュレーションを実行（非同期処理。結果はプロセスのデータテーブルに保存）

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

レスポンス（200）：

シミュレーションを開始しました

{
	"message": "string"
}

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

エラー：

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

直近のシミュレーション実行状況を取得（出力データテーブルから取得）

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
processId	string	path	はい	形式：`uuid`
simulationId	string	path	はい	形式：`uuid`

レスポンス（200）：

実行状況

{
	"state": "notStarted",
	"startedAt": "2024-03-15T16:30:00Z",
	"completedAt": "2024-03-15T16:30:00Z",
	"step": "string",
	"casesSimulated": 0,
	"targetCases": 0,
	"eventsGenerated": 0,
	"errorMessage": "string",
	"simulationId": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
state	`notStarted` \| `running` \| `processing` \| `ready` \| `error`	はい	許可される値：`notStarted`、`running`、`processing`、`ready`、`error`
startedAt	string	いいえ	形式：`date-time`
completedAt	string	いいえ	形式：`date-time`
step	string	いいえ
casesSimulated	number	いいえ
targetCases	number	いいえ
eventsGenerated	number	いいえ
errorMessage	string	いいえ
simulationId	string	はい	形式：`uuid`

エラー：

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

プロセスをより良く設計し、つながりのあるアーキテクチャを構築して、管理を続けましょう。

クレジットカード不要、待ち時間なしですぐにご利用いただけます。組織の業務の進め方を、明確につながるプロセス設計として可視化します。

プロセスアーキテクチャを構築し、オーナーシップと統制を定め、あらゆる階層で役割と責任を明確にします。

無料トライアルを開始して、プロセスのガバナンス、管理、継続的な改善を支える信頼できる基盤を築きましょう。

無料トライアルを開始

APIリファレンス：シミュレーション

プロセスのシミュレーション一覧を取得

シミュレーションを作成（IDを指定すると冪等に処理）

要素設定、属性、リソースを含むシミュレーションを取得

シミュレーションを更新（フィールドまたは要素設定）

シミュレーションを完全に削除

AIでシミュレーション設定を作成（非同期処理。ステータスエンドポイントをポーリング）

シミュレーション設定の作成状況を確認

シミュレーションを実行（非同期処理。結果はプロセスのデータテーブルに保存）

直近のシミュレーション実行状況を取得（出力データテーブルから取得）

関連文書

APIリファレンス：組織

APIリファレンス：テナント

APIリファレンス：データ

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

プロセスをより良く設計し、つながりのあるアーキテクチャを構築して、管理を続けましょう。