Ezen az oldalon
> erőforrások > dokumentáció > api > API referencia: szimulációk

API-referencia: szimulációk

A szimulációkkal „mi lenne, ha” forgatókönyveket futtathat a folyamatmodelljein. Beállíthatja a feldolgozási időket, az erőforrások elosztását és az érkezési gyakoriságot, majd előre jelezheti a folyamat működését.

Folyamat szimulációinak listázása

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/simulations

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
limit integer lekérdezés Nem A visszaadandó elemek maximális száma
offset integer lekérdezés Nem Kihagyandó elemek száma

Válasz (200):

Szimulációk listája

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

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Szimuláció létrehozása (megadott azonosító esetén idempotens)

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/simulations

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}
Mező Típus Kötelező Leírás
id string Nem Opcionális azonosító az idempotens újrapróbálkozásokhoz (UUID-nek kell lennie)
Formátum: uuid
displayName string Nem A szimuláció neve
Alapértelmezett: New Simulation
datasetName string Nem A szimulációhoz használt adatkészlet neve
startTime string Nem A szimuláció kezdési időpontja
Formátum: date-time
endTime string Nem A szimuláció befejezési időpontja
Formátum: date-time
useWarmUp boolean Nem A bemelegítési időszak kihagyása
Alapértelmezett: false

Válasz (201):

A szimuláció létrejött

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}
Mező Típus Kötelező Leírás
simulation object Igen
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található
  • 409 A kérés ütközik az aktuális állapottal (például felhasználói licenckorlát vagy már használt azonosító miatt)

Szimuláció lekérése az elemek beállításaival, attribútumaival és erőforrásaival

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Válasz (200):

Szimuláció részletei

{
	"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"
		}
	]
}
Mező Típus Kötelező Leírás
simulation object Igen A szimuláció fejléce
elementSettings object[] Igen Az egyes elemek szimulációs beállításai
attributes object[] Igen Szimulált attribútumok
resources object[] Igen Erőforráskészletek

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Szimuláció frissítése (mezők és/vagy elemek beállításai)

Végpont: PUT /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"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"
					}
				]
			}
		}
	]
}
Mező Típus Kötelező Leírás
displayName string Nem A szimuláció neve
datasetName string Nem A szimulációhoz használt adatkészlet neve
startTime string Nem A szimuláció kezdési időpontja
Formátum: date-time
endTime string Nem A szimuláció befejezési időpontja
Formátum: date-time
useWarmUp boolean Nem El kell-e hagyni a bemelegítési időszakot
elementSettings object[] Nem Elemenkénti beállítások felülírása

Válasz (200):

A szimuláció frissítve

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Szimuláció végleges törlése

Végpont: DELETE /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Válasz (200):

A szimuláció törölve

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Ezek a végpontok AI segítségével, a folyamatmodell alapján automatikusan állítják elő a szimuláció beállításait.

Szimulációs beállítások előállítása AI segítségével (aszinkron, kérdezze le az állapotot jelző végpontot)

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/generate-settings

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör · sebességkorlát: 2 kérés/s (csúcs: 4)

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"processDescription": "string",
	"additionalContext": "string"
}
Mező Típus Kötelező Leírás
processDescription string Nem
additionalContext string Nem

Válasz (200):

Az előállítás elindult / eredmény

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

A szimulációs beállítások előállítási állapotának lekérdezése

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

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Válasz (200):

Az előállítás állapota

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Szimuláció futtatásának indítása (aszinkron, az eredmények a folyamat adattábláiba kerülnek)

Végpont: POST /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör · sebességkorlát: 5 kérés/s (csúcs: 10)

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Válasz (200):

A szimuláció elindult

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

A legutóbbi szimulációfuttatás állapotának lekérdezése (a kimeneti adattáblából)

Végpont: GET /v1/tenant/{tenantId}/processes/{processId}/simulations/{simulationId}/run/status

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
processId string útvonal Igen Formátum: uuid
simulationId string útvonal Igen Formátum: uuid

Válasz (200):

A futtatás állapota

{
	"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"
}
Mező Típus Kötelező Leírás
state notStarted | running | processing | ready | error Igen Engedélyezett értékek: notStarted, running, processing, ready, error
startedAt string Nem Formátum: date-time
completedAt string Nem Formátum: date-time
step string Nem
casesSimulated number Nem
targetCases number Nem
eventsGenerated number Nem
errorMessage string Nem
simulationId string Igen Formátum: uuid

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Kapcsolódó dokumentáció

Tervezzen jobb folyamatokat. Építsen összekapcsolt architektúrát. Tartsa kézben a működést.

Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.

Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.

Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.

Indítsa el ingyenes próbaverzióját