API Referentie: Processen

Process Endpoints

List Processes

Bekijk alle processen in een tenant.

Endpoint: GET /tenant/{tenantId}/processes

Parameters:

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

Maak een nieuw process aan in een tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parameters:

Request Body:

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

Response: Geeft het aangemaakte process-object terug.

Get Process

Bekijk details van een specifiek process.

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

Parameters:

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

Werk een process bij (hernoemen of verplaatsen naar een andere map).

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

Parameters:

Request Body:

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

Response: Geeft het bijgewerkte process-object terug.

Delete Process

Verwijder een process en de bijbehorende data.

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

Parameters:

Response:

{
	"success": true
}

Upload BPMN

Upload een BPMN XML-bestand om een process model te maken of bij te werken.

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

Parameters:

Request Body:

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

Response: Geeft het bijgewerkte process-object met het nieuwe model terug.

Process Data Mapping Endpoints

Data mappings koppelen datatables aan processen, zodat je je event log data kunt bekijken en analyseren in een process model.

List Process Mappings

Bekijk alle data mappings voor een process.

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

Parameters:

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

Voeg een data table mapping toe aan een process.

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

Parameters:

Request Body:

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

Response: Geeft het aangemaakte mapping-object terug.

Update Process Mapping

Werk een bestaande data mapping weergave-instellingen bij.

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

Parameters:

Request Body:

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

Response: Geeft het bijgewerkte mapping-object terug.

Delete Process Mapping

Verwijder een data mapping uit een process.

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

Parameters:

Response:

{
	"success": true
}