API Referentie: Processen

Proces-endpoints

List Processes

Bekijk alle processen in een tenant.

Endpoint: GET /tenant/{tenantId}/processes

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant

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 proces aan in een tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant

Request Body:

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

Veld	Type	Verplicht	Omschrijving
displayName	string	Ja	Naam van het proces
treeNodeType	string	Nee	Moet Process (standaard) of TreeGroup zijn
treeParentId	string	Nee	ID van de bovenliggende groep

Response: Geeft het aangemaakte procesobject terug.

---

Get Process

Bekijk details van een specifiek proces.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces

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:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces

Request Body:

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

Veld	Type	Verplicht	Omschrijving
displayName	string	Nee	Nieuwe naam voor het proces
treeParentId	string	Nee	Nieuwe map ID

Response: Geeft het bijgewerkte procesobject terug.

---

Verwijderen Process

Verwijder een proces en de bijbehorende data.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces

Response:

{
	"success": true
}

---

BPMN uploaden

Upload een BPMN-XML-bestand om een procesmodel te definiëren of bij te werken.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces

Request Body:

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

Veld	Type	Verplicht	Omschrijving
bpmnXml	string	Ja	De BPMN 2.0-XML-inhoud als string

Response: Geeft het bijgewerkte procesobject met het nieuwe model terug.

---

Process Data-mapping Endpoints

Data mappings koppelen datatabellen aan processen, zodat je je gebeurtenislog-data kunt bekijken en analyseren in een procesmodel.

List Process Mappings

Bekijk alle data mappings voor een proces.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces

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 datatabel-mapping toe aan een proces.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces

Request Body:

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

Veld	Type	Verplicht	Omschrijving
dataTableId	string	Ja	ID van de datatabel om te koppelen
displayName	string	Nee	Weergavenaam van de mapping
color	object	Nee	Color object met id veld (data-1 t/m data-11)
showByDefault	boolean	Nee	Standaard zichtbaar (standaard: true)

Response: Geeft het aangemaakte mapping-object terug.

---

Update Process Mapping

Werk een bestaande data mapping de weergave-instellingen bij.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces
mappingId	string	path	Ja	De unieke kenmerk van de mapping

Request Body:

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

Veld	Type	Verplicht	Omschrijving
displayName	string	Nee	Nieuwe weergavenaam
color	object	Nee	Color object met id veld (data-1 t/m data-11)
showByDefault	boolean	Nee	Nieuwe standaard zichtbaarheid

Response: Geeft het bijgewerkte mapping-object terug.

---

Verwijderen Process Mapping

Verwijder een data mapping uit een proces.

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

Parameters:

Naam	Type	Locatie	Verplicht	Omschrijving
tenantId	string	path	Ja	Het unieke ID van de tenant
processId	string	path	Ja	Het unieke ID van het proces
mappingId	string	path	Ja	De unieke kenmerk van de mapping

Response:

{
	"success": true
}