API-Referenz: Prozesse

Prozesse auflisten

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · read-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
limit	Ganzzahl	Abfrage	Nein	Maximale Anzahl der zurückzugebenden Einträge
offset	Ganzzahl	Abfrage	Nein	Anzahl der zu überspringenden Einträge

Antwort (200):

Prozessliste

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen

Prozess erstellen (mit leerem Modell)

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	Zeichenfolge	Ja	Prozessname in der Prozessstruktur Maximale Länge: 128
treeParentId	Zeichenfolge	Nein	ID des übergeordneten Ordners (null = oberste Ebene) Format: uuid
treeNodeType	Process | TreeGroup	Nein	Prozess oder TreeGroup (Ordner) Zulässige Werte: Process, TreeGroup Standard: Process

Antwort (201):

Prozess erstellt

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
treeParentId	Zeichenfolge	Ja	Format: uuid
treeNodeType	Process | TreeGroup	Ja	Zulässige Werte: Process, TreeGroup Standard: Process
displayName	Zeichenfolge	Ja	Standard: New Process Maximale Länge: 128
createdAt	Zeichenfolge	Ja	Format: date-time
updatedAt	Zeichenfolge	Ja	Format: date-time
designerModelId	Zeichenfolge	Ja	Format: uuid

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 500 Unerwarteter Serverfehler: Die Anfrage kann gefahrlos wiederholt werden

Prozess abrufen

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · read-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

Prozess

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
treeParentId	Zeichenfolge	Ja	Format: uuid
treeNodeType	Process | TreeGroup	Ja	Zulässige Werte: Process, TreeGroup Standard: Process
displayName	Zeichenfolge	Ja	Standard: New Process Maximale Länge: 128
createdAt	Zeichenfolge	Ja	Format: date-time
updatedAt	Zeichenfolge	Ja	Format: date-time
designerModelId	Zeichenfolge	Ja	Format: uuid

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Prozess aktualisieren

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	Zeichenfolge	Nein	Prozessname in der Prozessstruktur Maximale Länge: 128
treeParentId	Zeichenfolge	Nein	ID des übergeordneten Ordners (null = oberste Ebene) Format: uuid

Antwort (200):

Prozess aktualisiert

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
treeParentId	Zeichenfolge	Ja	Format: uuid
treeNodeType	Process | TreeGroup	Ja	Zulässige Werte: Process, TreeGroup Standard: Process
displayName	Zeichenfolge	Ja	Standard: New Process Maximale Länge: 128
createdAt	Zeichenfolge	Ja	Format: date-time
updatedAt	Zeichenfolge	Ja	Format: date-time
designerModelId	Zeichenfolge	Ja	Format: uuid

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden
• 500 Unerwarteter Serverfehler: Die Anfrage kann gefahrlos wiederholt werden

Prozess vorläufig löschen

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

Prozess gelöscht

{
	"success": true,
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
success	boolesch	Ja
message	Zeichenfolge	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Prozessmodell als BPMN-2.0-XML exportieren

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · read-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

BPMN-XML

{
	"bpmnXml": "string"
}

Feld	Typ	Erforderlich	Beschreibung
bpmnXml	Zeichenfolge	Ja	BPMN-2.0-XML

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden
• 500 Unerwarteter Serverfehler: Die Anfrage kann gefahrlos wiederholt werden

BPMN-2.0-Modell für den Prozess importieren (ersetzt das aktuelle Modell)

Endpunkt: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"bpmnXml": "string"
}

Feld	Typ	Erforderlich	Beschreibung
bpmnXml	Zeichenfolge	Ja	BPMN-2.0-XML

Antwort (200):

BPMN hochgeladen

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	Zeichenfolge	Ja

Fehler:

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

Datenzuordnungen verknüpfen Datentabellen mit Prozessen. So können Sie die Daten des Event Log in einem Prozessmodell visualisieren und analysieren.

Datenzuordnungen für einen Prozess auflisten

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · read-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid
limit	Ganzzahl	Abfrage	Nein	Maximale Anzahl der zurückzugebenden Einträge
offset	Ganzzahl	Abfrage	Nein	Anzahl der zu überspringenden Einträge

Antwort (200):

Liste der Zuordnungen

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

Fehler:

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

Datentabelle dem Prozess zuordnen (startet die Verarbeitung des Event Log)

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

Feld	Typ	Erforderlich	Beschreibung
dataTableId	Zeichenfolge	Ja	Datentabelle, die dem Prozess zugeordnet werden soll Format: uuid
displayName	Zeichenfolge	Nein	Anzeigename der Zuordnung Maximale Länge: 128
color	Objekt	Nein	Akzentfarbe
showByDefault	boolesch	Nein	Diese Zuordnung standardmäßig in der Prozessansicht anzeigen Standard: true
mappingRole	primary | comparison	Nein	Rolle der zugeordneten Daten im Modell Zulässige Werte: primary, comparison

Antwort (201):

Zuordnung erstellt

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
modelId	Zeichenfolge	Ja	Format: uuid
dataTableId	Zeichenfolge	Ja	Format: uuid
displayName	Zeichenfolge	Ja	Maximale Länge: 128
color	Objekt	Ja
showByDefault	boolesch	Ja	Standard: true
mappingRole	primary | comparison	Ja	Zulässige Werte: primary, comparison Standard: comparison
sortOrder	Ganzzahl	Ja	Standard: 0 Minimum: -9007199254740991 Maximum: 9007199254740991

Fehler:

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

Zuordnung aktualisieren

Endpunkt: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid
mappingId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Feld	Typ	Erforderlich	Beschreibung
displayName	Zeichenfolge	Nein	Maximale Länge: 128
color	Objekt	Nein
showByDefault	boolesch	Nein
mappingRole	primary | comparison	Nein	Zulässige Werte: primary, comparison
sortOrder	Ganzzahl	Nein	Minimum: -9007199254740991 Maximum: 9007199254740991

Antwort (200):

Zuordnung aktualisiert

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
modelId	Zeichenfolge	Ja	Format: uuid
dataTableId	Zeichenfolge	Ja	Format: uuid
displayName	Zeichenfolge	Ja	Maximale Länge: 128
color	Objekt	Ja
showByDefault	boolesch	Ja	Standard: true
mappingRole	primary | comparison	Ja	Zulässige Werte: primary, comparison Standard: comparison
sortOrder	Ganzzahl	Ja	Standard: 0 Minimum: -9007199254740991 Maximum: 9007199254740991

Fehler:

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

Zuordnung löschen

Endpunkt: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid
mappingId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

Zuordnung gelöscht

{
	"success": true,
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
success	boolesch	Ja
message	Zeichenfolge	Ja

Fehler:

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

Diese Endpunkte verwenden KI, um BPMN-Prozessmodelle automatisch aus natürlichsprachlichen Beschreibungen zu generieren.

Prozessmodell aus einer natürlichsprachlichen Eingabe generieren (asynchron; Status über den Statusendpunkt abfragen)

Endpunkt: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang · Ratenbegrenzung: 2 Anfragen/s (Spitzenwert 4)

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"prompt": "string"
}

Feld	Typ	Erforderlich	Beschreibung
prompt	Zeichenfolge	Ja

Antwort (200):

Generierung gestartet / Ergebnis

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	Zeichenfolge	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Status der Modellgenerierung abfragen

Endpunkt: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

Generierungsstatus

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	Zeichenfolge	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Die Kennzahlen je Case für das neueste Modell des Prozesses: eine Zeile pro Case mit der berechneten Sequenz und den Prozessgesundheitskennzahlen.

Kennzahlen je Case für einen Prozess abrufen (neuestes Modell, paginiert)

Liefert für das neueste Modell des Prozesses eine Zeile je Case mit den berechneten Prozesskennzahlen (Case-Dauer, Länge, Konformität, Nacharbeit, Prozessgesundheit, Variante und weitere). Es werden keine Zeilen gefiltert. Das Ergebnis ist paginiert: Verwenden Sie limit (Standardwert 1000, Maximum 10000) und offset. Rufen Sie weitere Seiten ab, solange hasMore den Wert true hat. Solange die Kennzahlen noch berechnet werden, enthält die Antwort den Status preprocessing.

Endpunkt: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Authentifizierung: API-Schlüssel mit Mandantenzugriff · read-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid
limit	Ganzzahl	Abfrage	Nein	Maximale Anzahl der zurückzugebenden Case-Zeilen (Standardwert 1000, Maximum 10000)
offset	Ganzzahl	Abfrage	Nein	Anzahl der zu überspringenden Case-Zeilen (Standardwert 0)

Antwort (200):

Case-Kennzahlen

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

Fehler:

• 400 Ungültige Anfrage, z. B. ungültiger Filterausdruck, Prozess ohne Modell, nicht unterstützter Upload-Typ oder fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden
• 503 Datenpipeline nicht bereit oder vorgelagerte Abfrage fehlgeschlagen

Prozessversionen auflisten

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · read-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid
limit	Ganzzahl	Abfrage	Nein	Maximale Anzahl der zurückzugebenden Einträge
offset	Ganzzahl	Abfrage	Nein	Anzahl der zu überspringenden Einträge

Antwort (200):

Liste der Versionen

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Versionsstand des Prozesses erstellen

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

Authentifizierung: API-Schlüssel mit Mandantenzugriff · write-Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
processId	Zeichenfolge	Pfad	Ja	Format: uuid

Anfragekörper:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	Zeichenfolge	Nein	Versionsbezeichnung Standard: "" Maximale Länge: 128
description	Zeichenfolge	Nein	Optionale Beschreibung der Version
versionType	manual | auto	Nein	manuell = von einem Benutzer erstellt, auto = vom System erstellt Zulässige Werte: manual, auto
restoreFromVersionId	Zeichenfolge	Nein	Version, von der bei der Erstellung dieses Versionsstands wiederhergestellt werden soll Format: uuid

Antwort (201):

Version erstellt

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Feld	Typ	Erforderlich	Beschreibung
version	object	Ja
restoredFrom	object	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Prozessversion abrufen

Endpunkt: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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
versionId	string	path	Ja	Format: uuid

Antwort (200):

Version

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Feld	Typ	Erforderlich	Beschreibung
version	object	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Prozessversion umbenennen oder aktualisieren

Endpunkt: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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
versionId	string	path	Ja	Format: uuid

Anfragetext:

{
	"displayName": "string",
	"description": "string"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Versionsbezeichnung Maximale Länge: 128
description	string	Nein	Optionale Beschreibung der Version

Antwort (200):

Aktualisierte Version

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Feld	Typ	Erforderlich	Beschreibung
version	object	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Prozessversion löschen

Endpunkt: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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
versionId	string	path	Ja	Format: uuid

Antwort (200):

Version gelöscht

{
	"deleted": true
}

Feld	Typ	Erforderlich	Beschreibung
deleted	boolean	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Artefakt abrufen

Endpunkt: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

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

Antwort (200):

Artefakt

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
id	string	Ja	Format: uuid
displayName	string	Ja	Standard: "" Maximale Länge: 500
description	string	Ja	Maximale Länge: 2000
originalFileName	string	Ja	Standard: "" Maximale Länge: 500
mimeType	string	Ja	Standard: "" Maximale Länge: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Ja	Zulässige Werte: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Ja	Zulässige Werte: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Standard: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Ja	Zulässige Werte: Uploading, Ready, Failed, Deleted Standard: Uploading
hasThumbnail	boolean	Ja	Standard: false
sizeBytes	number	Ja	Standard: 0
createdAt	string	Ja	Format: date-time
createdBy	string	Nein	Format: uuid

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Anzeigename oder Beschreibung eines Artefakts aktualisieren

Endpunkt: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

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

Anfragetext:

{
	"displayName": "string",
	"description": "string"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Artefaktname Maximale Länge: 500
description	string	Nein	Optionale Beschreibung des Artefakts Maximale Länge: 2000

Antwort (200):

Artefakt aktualisiert

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Feld	Typ	Erforderlich	Beschreibung
id	string	Ja	Format: uuid
displayName	string	Ja	Standard: "" Maximale Länge: 500
description	string	Ja	Maximale Länge: 2000
originalFileName	string	Ja	Standard: "" Maximale Länge: 500
mimeType	string	Ja	Standard: "" Maximale Länge: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Ja	Zulässige Werte: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Ja	Zulässige Werte: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Standard: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Ja	Zulässige Werte: Uploading, Ready, Failed, Deleted Standard: Uploading
hasThumbnail	boolean	Ja	Standard: false
sizeBytes	number	Ja	Standard: 0
createdAt	string	Ja	Format: date-time
createdBy	string	Nein	Format: uuid

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Artefakt löschen

Endpunkt: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

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

Antwort (200):

Artefakt gelöscht

{
	"deleted": true
}

Feld	Typ	Erforderlich	Beschreibung
deleted	boolean	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Weiterleitung zu einer vorab signierten URL zum Herunterladen des Artefakts

Endpunkt: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

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

Fehler:

• 302 Weiterleitung zur vorab signierten Download-URL
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Artefakte eines Prozesses auflisten

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

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 Prozessartefakte

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Vorab signierte S3-Upload-URL für ein neues Prozessartefakt abrufen

Endpunkt: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

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:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

Feld	Typ	Erforderlich	Beschreibung
fileName	string	Ja
mimeType	string	Ja
sizeBytes	number	Ja
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	Nein	Zulässige Werte: modelIcon, processArtifact, doc, levelFrontPageImage Standard: processArtifact

Antwort (200):

Vorab signierte Upload-URL

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

Feld	Typ	Erforderlich	Beschreibung
artifactId	string	Ja	Format: uuid
originalUrl	string	Ja
thumbnailUrl	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
• 403 Dem API-Schlüssel fehlt der erforderliche Berechtigungsumfang oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt diesen Dateityp nicht zu
• 404 Ressource nicht gefunden
• 409 Die Anfrage steht im Konflikt mit dem aktuellen Status, z. B. wegen einer Lizenzplatzbeschränkung oder einer wiederverwendeten ID