API-Referenz: Prozesse

Prozesse auflisten

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
limit	integer	Abfrage	Nein	Maximale Anzahl zurückzugebender Elemente
offset	integer	Abfrage	Nein	Anzahl zu überspringender Elemente

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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel

Prozess erstellen (mit leerem Modell)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid

Request-Body:

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

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Ja	Im Prozessbaum angezeigter Prozessname Maximale Länge: 128
treeParentId	string	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):

Erstellter 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	string	Ja	Format: uuid
treeParentId	string	Ja	Format: uuid
treeNodeType	Process | TreeGroup	Ja	Zulässige Werte: Process, TreeGroup Standard: Process
displayName	string	Ja	Standard: New Process Maximale Länge: 128
createdAt	string	Ja	Format: date-time
updatedAt	string	Ja	Format: date-time
designerModelId	string	Ja	Format: uuid

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 500 Unerwarteter Serverfehler: Die Anfrage kann sicher wiederholt werden

Prozess abrufen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
processId	string	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	string	Ja	Format: uuid
treeParentId	string	Ja	Format: uuid
treeNodeType	Process | TreeGroup	Ja	Zulässige Werte: Process, TreeGroup Standard: Process
displayName	string	Ja	Standard: New Process Maximale Länge: 128
createdAt	string	Ja	Format: date-time
updatedAt	string	Ja	Format: date-time
designerModelId	string	Ja	Format: uuid

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Prozess aktualisieren

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
processId	string	Pfad	Ja	Format: uuid

Request-Body:

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

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Im Prozessbaum angezeigter Prozessname Maximale Länge: 128
treeParentId	string	Nein	ID des übergeordneten Ordners (null = oberste Ebene) Format: uuid

Antwort (200):

Aktualisierter 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	string	Ja	Format: uuid
treeParentId	string	Ja	Format: uuid
treeNodeType	Process | TreeGroup	Ja	Zulässige Werte: Process, TreeGroup Standard: Process
displayName	string	Ja	Standard: New Process Maximale Länge: 128
createdAt	string	Ja	Format: date-time
updatedAt	string	Ja	Format: date-time
designerModelId	string	Ja	Format: uuid

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden
• 500 Unerwarteter Serverfehler: Die Anfrage kann sicher wiederholt werden

Prozess vorläufig löschen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
processId	string	Pfad	Ja	Format: uuid

Antwort (200):

Prozess gelöscht

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

Feld	Typ	Erforderlich	Beschreibung
success	boolean	Ja
message	string	Ja

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Prozessmodell als BPMN-2.0-XML exportieren

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
processId	string	Pfad	Ja	Format: uuid

Antwort (200):

BPMN-XML

{
	"bpmnXml": "string"
}

Feld	Typ	Erforderlich	Beschreibung
bpmnXml	string	Ja	BPMN 2.0 XML

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden
• 500 Unerwarteter Serverfehler: Die Anfrage kann sicher wiederholt werden

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

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
processId	string	Pfad	Ja	Format: uuid

Request-Body:

{
	"bpmnXml": "string"
}

Feld	Typ	Erforderlich	Beschreibung
bpmnXml	string	Ja	BPMN 2.0 XML

Antwort (200):

BPMN hochgeladen

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	string	Ja

Fehler:

• 400 Ungültige Anfrage, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Datenzuordnungen verknüpfen Datentabellen mit Prozessen. Dadurch können Sie Ihre Event-Log-Daten in einem Prozessmodell visualisieren und analysieren.

Datenzuordnungen für einen Prozess auflisten

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	Pfad	Ja	Format: uuid
processId	string	Pfad	Ja	Format: uuid
limit	integer	Abfrage	Nein	Maximale Anzahl zurückzugebender Elemente
offset	integer	Abfrage	Nein	Anzahl zu überspringender Elemente

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, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

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

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Request Body:

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

Feld	Typ	Erforderlich	Beschreibung
dataTableId	string	Ja	Datatable, die dem Prozess zugeordnet wird Format: uuid
displayName	string	Nein	Anzeigename der Zuordnung Maximale Länge: 128
color	object	Nein	Akzentfarbe
showByDefault	boolean	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

Response (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	string	Ja	Format: uuid
modelId	string	Ja	Format: uuid
dataTableId	string	Ja	Format: uuid
displayName	string	Ja	Maximale Länge: 128
color	object	Ja
showByDefault	boolean	Ja	Standard: true
mappingRole	primary | comparison	Ja	Zulässige Werte: primary, comparison Standard: comparison
sortOrder	integer	Ja	Standard: 0 Minimum: -9007199254740991 Maximum: 9007199254740991

Fehler:

• 400 Ungültige Anfrage, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Zuordnung aktualisieren

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Request Body:

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

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Maximale Länge: 128
color	object	Nein
showByDefault	boolean	Nein
mappingRole	primary | comparison	Nein	Zulässige Werte: primary, comparison
sortOrder	integer	Nein	Minimum: -9007199254740991 Maximum: 9007199254740991

Response (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	string	Ja	Format: uuid
modelId	string	Ja	Format: uuid
dataTableId	string	Ja	Format: uuid
displayName	string	Ja	Maximale Länge: 128
color	object	Ja
showByDefault	boolean	Ja	Standard: true
mappingRole	primary | comparison	Ja	Zulässige Werte: primary, comparison Standard: comparison
sortOrder	integer	Ja	Standard: 0 Minimum: -9007199254740991 Maximum: 9007199254740991

Fehler:

• 400 Ungültige Anfrage, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Zuordnung löschen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Response (200):

Zuordnung gelöscht

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

Feld	Typ	Erforderlich	Beschreibung
success	boolean	Ja
message	string	Ja

Fehler:

• 400 Ungültige Anfrage, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

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

Prozessmodell aus einem natürlichsprachlichen Prompt generieren (asynchron, Status-Endpunkt abfragen)

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich · Ratenbegrenzung 2 Anfragen/s (Burst 4)

Parameter:

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

Request Body:

{
	"prompt": "string"
}

Feld	Typ	Erforderlich	Beschreibung
prompt	string	Ja

Response (200):

Generierung gestartet / Ergebnis

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	string	Ja

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Status der Modellgenerierung abfragen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Response (200):

Generierungsstatus

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	string	Ja

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Die Kennzahlen pro Case des neuesten Prozessmodells: eine Zeile pro Case mit der berechneten Sequenz sowie den Kennzahlen zur Prozessgesundheit.

Kennzahlen pro Case eines Prozesses abrufen (neuestes Modell, paginiert)

Gibt für das neueste Prozessmodell eine Zeile pro Case mit den berechneten Prozesskennzahlen zurück, darunter Case-Dauer, Länge, Konformität, Nacharbeit, Prozessgesundheit, Variante und weitere Kennzahlen. Es wird keine Filterung der Zeilen angewendet. Das Ergebnis ist paginiert: Verwenden Sie limit (Standard 1000, Maximum 10000) und offset. Fahren Sie mit der Paginierung fort, solange hasMore den Wert true hat. Während die Kennzahlen noch berechnet werden, lautet der Status der Response preprocessing.

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid
processId	string	path	Ja	Format: uuid
limit	integer	query	Nein	Maximale Anzahl zurückzugebender Case-Zeilen (Standard 1000, Maximum 10000)
offset	integer	query	Nein	Anzahl zu überspringender Case-Zeilen (Standard 0)

Response (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, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden
• 503Datenpipeline nicht bereit oder eine vorgelagerte Abfrage ist fehlgeschlagen

Prozessversionen auflisten

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid
processId	string	path	Ja	Format: uuid
limit	integer	query	Nein	Maximale Anzahl zurückzugebender Elemente
offset	integer	query	Nein	Anzahl zu überspringender Elemente

Response (200):

Versionsliste

[
	{
		"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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Versionsstand des Prozesses erstellen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Request Body:

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

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Versionsbezeichnung Standard: "" Maximale Länge: 128
description	string	Nein	Optionale Beschreibung der Version
versionType	manual | auto	Nein	manuell = vom Benutzer erstellt, auto = vom System erstellt Zulässige Werte: manual, auto
restoreFromVersionId	string	Nein	Version, aus der dieser Versionsstand erstellt werden soll Format: uuid

Response (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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Prozessversion abrufen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

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

Response (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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Prozessversion umbenennen oder aktualisieren

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Request Body:

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

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

Response (200):

Version aktualisiert

{
	"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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Prozessversion löschen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Response (200):

Version gelöscht

{
	"deleted": true
}

Feld	Typ	Erforderlich	Beschreibung
deleted	boolean	Ja

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Artefakt abrufen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

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

Response (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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Anzeigenamen oder Beschreibung eines Artefakts aktualisieren

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Request Body:

{
	"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

Response (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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Artefakt löschen

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

Authentifizierung: Mandantenbezogener API-Schlüssel · write-Bereich

Parameter:

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

Response (200):

Artefakt gelöscht

{
	"deleted": true
}

Feld	Typ	Erforderlich	Beschreibung
deleted	boolean	Ja

Fehler:

• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

Zu einer vorab signierten URL zum Download des Artefakts weiterleiten

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

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

Fehler:

• 302 Weiterleitung zur vorab signierten Download-URL
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 404 Ressource nicht gefunden

An einen Prozess angehängte Artefakte auflisten

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid
processId	string	path	Ja	Format: uuid
limit	integer	query	Nein	Maximale Anzahl zurückzugebender Elemente
offset	integer	query	Nein	Anzahl zu überspringender Elemente

Response (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 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 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-Bereich

Parameter:

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

Request Body:

{
	"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

Response (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, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
• 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
• 403 Dem API-Schlüssel fehlt der erforderliche Bereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif blockiert den Dateityp
• 404 Ressource nicht gefunden
• 409 Die Anfrage steht im Konflikt mit dem aktuellen Status, zum Beispiel wegen einer Lizenzplatzbeschränkung oder einer wiederverwendeten ID