Auf dieser Seite
> ressourcen > dokumentation > api > API Referenz: Simulationen

API-Referenz: Simulationen

Mit Simulationen können Sie Was-wäre-wenn-Szenarien für Ihre Prozessmodelle durchspielen. Konfigurieren Sie Verarbeitungszeiten, Ressourcenzuweisungen und Ankunftsraten, um das Prozessverhalten vorherzusagen.

Simulationen für einen Prozess auflisten

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
limit integer query Nein Maximale Anzahl der zurückzugebenden Elemente
offset integer query Nein Anzahl der zu überspringenden Elemente

Antwort (200):

Liste der Simulationen

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

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Simulation erstellen (bei Angabe einer ID idempotent)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid

Anfragetext:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"datasetName": "string",
	"startTime": "2024-03-15T16:30:00Z",
	"endTime": "2024-03-15T16:30:00Z",
	"useWarmUp": true
}
Feld Typ Erforderlich Beschreibung
id string Nein Optionale ID für idempotente Wiederholungsversuche (muss eine UUID sein)
Format: uuid
displayName string Nein Simulationsname
Standard: New Simulation
datasetName string Nein Name des Datensatzes, auf dem die Simulation ausgeführt wird
startTime string Nein Startzeit der Simulation
Format: date-time
endTime string Nein Endzeit der Simulation
Format: date-time
useWarmUp boolean Nein Gibt an, ob die Aufwärmphase verworfen wird
Standard: false

Antwort (201):

Simulation erstellt

{
	"simulation": {
		"id": "00000000-0000-0000-0000-000000000000",
		"displayName": "string"
	},
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
simulation object Ja
message string Ja

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden
  • 409 Die Anfrage steht im Konflikt mit dem aktuellen Status, z. B. wegen einer Lizenzplatzbeschränkung oder einer wiederverwendeten ID

Simulation mit Elementeinstellungen, Attributen und Ressourcen abrufen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Antwort (200):

Simulationsdetails

{
	"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"
		}
	]
}
Feld Typ Erforderlich Beschreibung
simulation object Ja Simulationskopf
elementSettings object[] Ja Simulationseinstellungen je Element
attributes object[] Ja Simulierte Attribute
resources object[] Ja Ressourcenpools

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Simulation aktualisieren (Felder und/oder Elementeinstellungen)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Anfragetext:

{
	"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"
					}
				]
			}
		}
	]
}
Feld Typ Erforderlich Beschreibung
displayName string Nein Simulationsname
datasetName string Nein Name des Datensatzes, auf dem die Simulation ausgeführt wird
startTime string Nein Startzeit der Simulation
Format: date-time
endTime string Nein Endzeit der Simulation
Format: date-time
useWarmUp boolean Nein Gibt an, ob die Aufwärmphase verworfen wird
elementSettings object[] Nein Überschreibungen der Einstellungen je Element

Antwort (200):

Simulation aktualisiert

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Simulation endgültig löschen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Antwort (200):

Simulation gelöscht

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Diese Endpunkte verwenden KI, um auf Grundlage des Prozessmodells automatisch Simulationseinstellungen zu generieren.

Simulationseinstellungen mit KI generieren (asynchron; Status über den Statusendpunkt abfragen)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang · Anfragelimit 2 Anfragen/s (Spitze: 4)

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Anfragetext:

{
	"processDescription": "string",
	"additionalContext": "string"
}
Feld Typ Erforderlich Beschreibung
processDescription string Nein
additionalContext string Nein

Antwort (200):

Generierung gestartet / Ergebnis

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Status der Generierung von Simulationseinstellungen abfragen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Antwort (200):

Generierungsstatus

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Simulationslauf starten (asynchron; Ergebnisse werden in den Datentabellen des Prozesses gespeichert)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang · Anfragelimit 5 Anfragen/s (Spitze: 10)

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Antwort (200):

Simulation gestartet

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Status des letzten Simulationslaufs abrufen (aus der Ausgabedatentabelle abgeleitet)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string path Ja Format: uuid
processId string path Ja Format: uuid
simulationId string path Ja Format: uuid

Antwort (200):

Ausführungsstatus

{
	"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"
}
Feld Typ Erforderlich Beschreibung
state notStarted | running | processing | ready | error Ja Zulässige Werte: notStarted, running, processing, ready, error
startedAt string Nein Format: date-time
completedAt string Nein Format: date-time
step string Nein
casesSimulated number Nein
targetCases number Nein
eventsGenerated number Nein
errorMessage string Nein
simulationId string Ja Format: uuid

Fehler:

  • 400 Ungültige Anfrage, z. B. ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein erforderliches Feld fehlt
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Zugehörige Dokumentation

Verbessern Sie Prozesse. Schaffen Sie eine vernetzte Architektur. Behalten Sie die Kontrolle.

Erhalten Sie sofort Zugriff, ohne Kreditkarte und Wartezeit. Bilden Sie die Arbeitsweise Ihrer Organisation in klaren, vernetzten Prozessmodellen ab.

Entwickeln Sie Ihre Prozessarchitektur, definieren Sie Zuständigkeiten und Kontrollen und stimmen Sie Rollen und Verantwortlichkeiten auf allen Ebenen ab.

Starten Sie Ihre kostenlose Testphase und schaffen Sie eine verlässliche Grundlage, um Ihre Prozesse zu steuern und kontinuierlich zu verbessern.

Starten Sie Ihre kostenlose Testphase