Dokumentenliste

Auf dieser Seite

> ressourcen > dokumente > api > API Reference: Processes

API Reference: Processes

Process Endpoints

List Processes

Zeigt alle Processes in einem Tenant an.

Endpoint: GET /tenant/{tenantId}/processes

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants

Response:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

Create Process

Erstellt einen neuen Process in einem Tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants

Request Body:

{
	"displayName": "My New Process",
	"treeNodeType": "Process",
	"treeParentId": null
}

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Ja	Name des Process
treeNodeType	string	Nein	Muss `Process` (Standard) oder `TreeGroup` sein
treeParentId	string	Nein	Übergeordnete Ordner-ID zur Organisation

Response: Gibt das erstellte Process-Objekt zurück.

Get Process

Ruft Details zu einem bestimmten Process ab.

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

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process

Response:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

Update Process

Aktualisiert einen Process (umbenennen oder in einen anderen Ordner verschieben).

Endpoint: PUT /tenant/{tenantId}/processes/{processId}

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process

Request Body:

{
	"displayName": "Updated Process Name",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Neuer Name für den Process
treeParentId	string	Nein	Neue Ordner-ID

Response: Gibt das aktualisierte Process-Objekt zurück.

Delete Process

Löscht einen Process und die zugehörigen Daten.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process

Response:

{
	"success": true
}

Upload BPMN

Laden Sie eine BPMN XML-Datei hoch, um ein Process Model zu definieren oder zu aktualisieren.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/bpmn

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process

Request Body:

{
	"bpmnXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

Feld	Typ	Erforderlich	Beschreibung
bpmnXml	string	Ja	BPMN 2.0 XML-Inhalt als String

Response: Gibt das aktualisierte Process-Objekt mit dem neuen Model zurück.

Process Data Mapping Endpoints

Mit Data Mappings verbinden Sie Datatables mit Processes, um Ihre Event Log Daten im Process Model einfacher zu visualisieren und zu analysieren.

List Process Mappings

Zeigt alle Data Mappings für einen Process an.

Endpoint: GET /tenant/{tenantId}/processes/{processId}/mappings

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process

Response:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

Create Process Mapping

Fügen Sie einem Process eine Data Table Mapping hinzu.

Endpoint: POST /tenant/{tenantId}/processes/{processId}/mappings

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process

Request Body:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}

Feld	Typ	Erforderlich	Beschreibung
dataTableId	string	Ja	ID der zuzuordnenden Datatable
displayName	string	Nein	Anzeigename für das Mapping
color	object	Nein	Color-Objekt mit `id`-Feld (data-1 bis data-11)
showByDefault	boolean	Nein	Standardmäßig anzeigen (Standard: true)

Response: Gibt das erstellte Mapping-Objekt zurück.

Update Process Mapping

Aktualisiert die Anzeige-Einstellungen einer bestehenden Data Mapping.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process
mappingId	string	path	Ja	Die eindeutige ID des Mappings

Request Body:

{
	"displayName": "Updated Name",
	"color": { "id": "data-2" },
	"showByDefault": false
}

Feld	Typ	Erforderlich	Beschreibung
displayName	string	Nein	Neuer Anzeigename
color	object	Nein	Color-Objekt mit `id`-Feld (data-1 bis data-11)
showByDefault	boolean	Nein	Neue Standard-Sichtbarkeit

Response: Gibt das aktualisierte Mapping-Objekt zurück.

Delete Process Mapping

Entfernt ein Data Mapping aus einem Process.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID des Tenants
processId	string	path	Ja	Die eindeutige ID des Process
mappingId	string	path	Ja	Die eindeutige ID des Mappings

Response:

{
	"success": true
}