Na této stránce
> zdroje > dokumentace > api > Referenční příručka API: simulace

Referenční příručka API: simulace

Simulace umožňují testovat scénáře „co kdyby“ nad modely procesů. Můžete nastavit dobu zpracování, přidělení zdrojů a četnost příchodů a předpovědět tak chování procesu.

Výpis simulací procesu

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam simulací

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

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Vytvoření simulace (při zadání ID lze požadavek bezpečně opakovat)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/simulations

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid

Tělo požadavku:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}
Pole Typ Povinné Popis
id string Ne Volitelné ID pro opakování požadavku bez duplicit (musí být UUID)
Formát: uuid
displayName string Ne Název simulace
Výchozí hodnota: New Simulation
datasetName string Ne Název datové sady, nad kterou simulace běží
startTime string Ne Čas zahájení simulace
Formát: date-time
endTime string Ne Čas ukončení simulace
Formát: date-time
useWarmUp boolean Ne Zda vynechat zahřívací období
Výchozí hodnota: false

Odpověď (201):

Simulace byla vytvořena

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}
Pole Typ Povinné Popis
simulation object Ano
message string Ano

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen
  • 409Požadavek je v konfliktu s aktuálním stavem (například kvůli omezení počtu licencí nebo opakovanému použití ID)

Načtení simulace včetně nastavení prvků, atributů a zdrojů

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
processId string path Ano Formát: uuid
simulationId string path Ano Formát: uuid

Odpověď (200):

Podrobnosti simulace

{
	"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"
		}
	]
}
Pole Typ Povinné Popis
simulation object Ano Základní údaje o simulaci
elementSettings object[] Ano Nastavení simulace pro jednotlivé prvky
attributes object[] Ano Simulované atributy
resources object[] Ano Skupiny zdrojů

Chyby:

  • 400 Chybný požadavek: například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
  • 404 Zdroj nebyl nalezen

Aktualizace simulace (polí a/nebo nastavení prvků)

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Ověření: API klíč pro konkrétního tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
processId string cesta Ano Formát: uuid
simulationId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"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"
					}
				]
			}
		}
	]
}
Pole Typ Povinné Popis
displayName string Ne Název simulace
datasetName string Ne Název datasetu, nad kterým simulace běží
startTime string Ne Čas zahájení simulace
Formát: date-time
endTime string Ne Čas ukončení simulace
Formát: date-time
useWarmUp boolean Ne Zda se má zahřívací období vynechat
elementSettings object[] Ne Přepsání nastavení jednotlivých prvků

Odpověď (200):

Simulace byla aktualizována

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Trvale odstranit simulaci

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
processId string cesta Ano Formát: uuid
simulationId string cesta Ano Formát: uuid

Odpověď (200):

Simulace byla odstraněna

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Tyto endpointy využívají AI k automatickému generování nastavení simulace podle procesního modelu.

Generovat nastavení simulace pomocí AI (asynchronně, stav zjišťujte přes endpoint pro stav)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/generate-settings

Ověření: API key s rozsahem tenanta · rozsah write · limit 2 požadavky/s (nárazově 4)

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
processId string cesta Ano Formát: uuid
simulationId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"processDescription": "string",
	"additionalContext": "string"
}
Pole Typ Povinné Popis
processDescription string Ne
additionalContext string Ne

Odpověď (200):

Generování zahájeno / výsledek

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Zjistit stav generování nastavení simulace

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/generate-settings/status

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
processId string cesta Ano Formát: uuid
simulationId string cesta Ano Formát: uuid

Odpověď (200):

Stav generování

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Spustit simulaci (asynchronně, výsledky se uloží do datových tabulek procesu)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run

Ověření: API key s rozsahem tenanta · rozsah write · limit 5 požadavků/s (nárazově 10)

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
processId string cesta Ano Formát: uuid
simulationId string cesta Ano Formát: uuid

Odpověď (200):

Simulace byla spuštěna

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Zjistit stav posledního spuštění simulace (odvozený z výstupní datové tabulky)

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run/status

Ověření: API key s rozsahem tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
processId string cesta Ano Formát: uuid
simulationId string cesta Ano Formát: uuid

Odpověď (200):

Stav spuštění

{
	"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"
}
Pole Typ Povinné Popis
state notStarted | running | processing | ready | error Ano Povolené hodnoty: notStarted, running, processing, ready, error
startedAt string Ne Formát: date-time
completedAt string Ne Formát: date-time
step string Ne
casesSimulated number Ne
targetCases number Ne
eventsGenerated number Ne
errorMessage string Ne
simulationId string Ano Formát: uuid

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Související dokumentace

Navrhujte lepší procesy. Propojte je do společné architektury. Mějte vše pod kontrolou.

Získejte přístup ihned, bez čekání a bez platební karty. Převádějte způsob práce ve své organizaci do přehledných a propojených návrhů procesů.

Vytvořte architekturu procesů, určete vlastníky a kontrolní mechanismy a slaďte role a odpovědnosti na všech úrovních.

Spusťte zkušební verzi a vytvořte spolehlivý základ pro řízení, správu a průběžné zlepšování procesů.

Získejte zkušební verzi zdarma