API-referentie: processen

Processen weergeven

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

Auth: Tenantgebonden API-sleutel · read-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt geretourneerd
offset	integer	query	Nee	Aantal over te slaan items

Response (200):

Lijst met processen

[
	{
		"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"
	}
]

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel

Een proces maken (met een leeg model)

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

Auth: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid

Request body:

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

Veld	Type	Vereist	Beschrijving
displayName	string	Ja	Procesnaam die in de procesboom wordt weergegeven Maximale lengte: 128
treeParentId	string	Nee	ID van de bovenliggende map (null = hoogste niveau) Indeling: uuid
treeNodeType	Process | TreeGroup	Nee	Proces of TreeGroup (map) Toegestane waarden: Process, TreeGroup Standaard: Process

Response (201):

Proces gemaakt

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

Veld	Type	Vereist	Beschrijving
id	string	Ja	Indeling: uuid
treeParentId	string	Ja	Indeling: uuid
treeNodeType	Process | TreeGroup	Ja	Toegestane waarden: Process, TreeGroup Standaard: Process
displayName	string	Ja	Standaard: New Process Maximale lengte: 128
createdAt	string	Ja	Indeling: date-time
updatedAt	string	Ja	Indeling: date-time
designerModelId	string	Ja	Indeling: uuid

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 500 Onverwachte serverfout: het verzoek kan veilig opnieuw worden geprobeerd

Een proces ophalen

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

Auth: Tenantgebonden API-sleutel · read-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
processId	string	pad	Ja	Indeling: uuid

Response (200):

Proces

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

Veld	Type	Vereist	Beschrijving
id	string	Ja	Indeling: uuid
treeParentId	string	Ja	Indeling: uuid
treeNodeType	Process | TreeGroup	Ja	Toegestane waarden: Process, TreeGroup Standaard: Process
displayName	string	Ja	Standaard: New Process Maximale lengte: 128
createdAt	string	Ja	Indeling: date-time
updatedAt	string	Ja	Indeling: date-time
designerModelId	string	Ja	Indeling: uuid

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een proces bijwerken

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

Auth: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
processId	string	pad	Ja	Indeling: uuid

Request body:

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

Veld	Type	Vereist	Beschrijving
displayName	string	Nee	Procesnaam die in de procesboom wordt weergegeven Maximale lengte: 128
treeParentId	string	Nee	ID van de bovenliggende map (null = hoogste niveau) Indeling: uuid

Response (200):

Proces bijgewerkt

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

Veld	Type	Vereist	Beschrijving
id	string	Ja	Indeling: uuid
treeParentId	string	Ja	Indeling: uuid
treeNodeType	Process | TreeGroup	Ja	Toegestane waarden: Process, TreeGroup Standaard: Process
displayName	string	Ja	Standaard: New Process Maximale lengte: 128
createdAt	string	Ja	Indeling: date-time
updatedAt	string	Ja	Indeling: date-time
designerModelId	string	Ja	Indeling: uuid

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden
• 500 Onverwachte serverfout: het verzoek kan veilig opnieuw worden geprobeerd

Een proces soft deleten

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

Auth: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
processId	string	pad	Ja	Indeling: uuid

Response (200):

Proces verwijderd

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

Veld	Type	Vereist	Beschrijving
success	boolean	Ja
message	string	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Het procesmodel exporteren als BPMN 2.0 XML

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

Auth: Tenantgebonden API-sleutel · read-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
processId	string	pad	Ja	Indeling: uuid

Response (200):

BPMN XML

{
	"bpmnXml": "string"
}

Veld	Type	Vereist	Beschrijving
bpmnXml	string	Ja	BPMN 2.0 XML

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden
• 500 Onverwachte serverfout: het verzoek kan veilig opnieuw worden geprobeerd

Een BPMN 2.0-model voor het proces importeren (vervangt het huidige model)

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

Auth: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
processId	string	pad	Ja	Indeling: uuid

Request body:

{
	"bpmnXml": "string"
}

Veld	Type	Vereist	Beschrijving
bpmnXml	string	Ja	BPMN 2.0 XML

Response (200):

BPMN geüpload

{
	"message": "string"
}

Veld	Type	Vereist	Beschrijving
message	string	Ja

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Datamappings koppelen datatabellen aan processen. Zo kun je data uit event logs op een procesmodel visualiseren en analyseren.

Datamappings voor een proces weergeven

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

Auth: Tenantgebonden API-sleutel · read-scope

Parameters:

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja	Indeling: uuid
processId	string	pad	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt geretourneerd
offset	integer	query	Nee	Aantal over te slaan items

Response (200):

Lijst met mappings

[
	{
		"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
	}
]

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een datatabel aan het proces koppelen (start de verwerking van het event log)

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

Auth: Tenantgebonden API-sleutel · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
dataTableId	string	Ja	Datatable die aan het proces wordt gekoppeld Indeling: uuid
displayName	string	Nee	Weergavenaam van de koppeling Maximale lengte: 128
color	object	Nee	Accentkleur
showByDefault	boolean	Nee	Deze koppeling standaard in de procesweergave tonen Standaard: true
mappingRole	primary | comparison	Nee	Rol van de gekoppelde data in het model Toegestane waarden: primary, comparison

Response (201):

Koppeling aangemaakt

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
modelId	string	Ja	Indeling: uuid
dataTableId	string	Ja	Indeling: uuid
displayName	string	Ja	Maximale lengte: 128
color	object	Ja
showByDefault	boolean	Ja	Standaard: true
mappingRole	primary | comparison	Ja	Toegestane waarden: primary, comparison Standaard: comparison
sortOrder	integer	Ja	Standaard: 0 Minimum: -9007199254740991 Maximum: 9007199254740991

Fouten:

• 400 Ongeldige aanvraag, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een koppeling bijwerken

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
mappingId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Nee	Maximale lengte: 128
color	object	Nee
showByDefault	boolean	Nee
mappingRole	primary | comparison	Nee	Toegestane waarden: primary, comparison
sortOrder	integer	Nee	Minimum: -9007199254740991 Maximum: 9007199254740991

Response (200):

Koppeling bijgewerkt

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
modelId	string	Ja	Indeling: uuid
dataTableId	string	Ja	Indeling: uuid
displayName	string	Ja	Maximale lengte: 128
color	object	Ja
showByDefault	boolean	Ja	Standaard: true
mappingRole	primary | comparison	Ja	Toegestane waarden: primary, comparison Standaard: comparison
sortOrder	integer	Ja	Standaard: 0 Minimum: -9007199254740991 Maximum: 9007199254740991

Fouten:

• 400 Ongeldige aanvraag, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een koppeling verwijderen

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
mappingId	string	path	Ja	Indeling: uuid

Response (200):

Koppeling verwijderd

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

Veld	Type	Verplicht	Beschrijving
success	boolean	Ja
message	string	Ja

Fouten:

• 400 Ongeldige aanvraag, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Deze endpoints gebruiken AI om automatisch BPMN-procesmodellen te genereren op basis van beschrijvingen in natuurlijke taal.

Een procesmodel genereren op basis van een prompt in natuurlijke taal (asynchroon, controleer het statusendpoint)

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

Auth: API-sleutel met tenant-scope · write scope · limiet 2 req/s (burst 4)

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid

Request body:

{
	"prompt": "string"
}

Veld	Type	Verplicht	Beschrijving
prompt	string	Ja

Response (200):

Genereren gestart / resultaat

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

De status van het genereren van een model controleren

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid

Response (200):

Generatiestatus

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

De metrics per case van het nieuwste model van het proces: één rij per case met de berekende sequentie- en gezondheidsmetrics.

Metrics per case van een proces ophalen (nieuwste model, gepagineerd)

Geeft één rij per case met de berekende procesmetrics, zoals caselange, lengte, conformance, herstelwerk, gezondheidsscore en variant, voor het nieuwste model van het proces. Er wordt geen rijfilter toegepast. Het resultaat is gepagineerd: gebruik limit (standaard 1000, maximaal 10000) en offset, en blijf pagina’s ophalen zolang hasMore waar is. Zolang de metrics nog worden berekend, heeft de response de status preprocessing.

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal caserijen dat wordt geretourneerd (standaard 1000, maximaal 10000)
offset	integer	query	Nee	Aantal caserijen dat wordt overgeslagen (standaard 0)

Response (200):

Metrics per case

{
	"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": [
		{}
	]
}

Fouten:

• 400 Ongeldige aanvraag, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden
• 503 Datapijplijn niet gereed of een upstream-query is mislukt

Procesversies weergeven

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt geretourneerd
offset	integer	query	Nee	Aantal items dat wordt overgeslagen

Response (200):

Lijst met versies

[
	{
		"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
	}
]

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een versiesnapshot van het proces maken

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Nee	Versielabel Standaard: "" Maximale lengte: 128
description	string	Nee	Optionele beschrijving van de versie
versionType	manual | auto	Nee	handmatig = door de gebruiker aangemaakt, auto = door het systeem aangemaakt Toegestane waarden: manual, auto
restoreFromVersionId	string	Nee	Versie waarvan wordt hersteld bij het maken van deze snapshot Indeling: uuid

Response (201):

Versie aangemaakt

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

Veld	Type	Verplicht	Beschrijving
version	object	Ja
restoredFrom	object	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een procesversie ophalen

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
versionId	string	path	Ja	Indeling: uuid

Response (200):

Versie

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

Veld	Type	Verplicht	Beschrijving
version	object	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een procesversie hernoemen of bijwerken

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
versionId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Nee	Versielabel Maximale lengte: 128
description	string	Nee	Optionele beschrijving van de versie

Response (200):

Bijgewerkte versie

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

Veld	Type	Verplicht	Beschrijving
version	object	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een procesversie verwijderen

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
versionId	string	path	Ja	Indeling: uuid

Response (200):

Versie verwijderd

{
	"deleted": true
}

Veld	Type	Verplicht	Beschrijving
deleted	boolean	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een artifact ophalen

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
artifactId	string	path	Ja	Indeling: uuid

Response (200):

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
displayName	string	Ja	Standaard: "" Maximale lengte: 500
description	string	Ja	Maximale lengte: 2000
originalFileName	string	Ja	Standaard: "" Maximale lengte: 500
mimeType	string	Ja	Standaard: "" Maximale lengte: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Ja	Toegestane waarden: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Ja	Toegestane waarden: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Standaard: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Ja	Toegestane waarden: Uploading, Ready, Failed, Deleted Standaard: Uploading
hasThumbnail	boolean	Ja	Standaard: false
sizeBytes	number	Ja	Standaard: 0
createdAt	string	Ja	Indeling: date-time
createdBy	string	Nee	Indeling: uuid

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

De weergavenaam of beschrijving van een artifact bijwerken

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
artifactId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Nee	Naam van het artifact Maximale lengte: 500
description	string	Nee	Optionele beschrijving van het artifact Maximale lengte: 2000

Response (200):

Bijgewerkt 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"
}

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
displayName	string	Ja	Standaard: "" Maximale lengte: 500
description	string	Ja	Maximale lengte: 2000
originalFileName	string	Ja	Standaard: "" Maximale lengte: 500
mimeType	string	Ja	Standaard: "" Maximale lengte: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Ja	Toegestane waarden: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Ja	Toegestane waarden: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Standaard: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Ja	Toegestane waarden: Uploading, Ready, Failed, Deleted Standaard: Uploading
hasThumbnail	boolean	Ja	Standaard: false
sizeBytes	number	Ja	Standaard: 0
createdAt	string	Ja	Indeling: date-time
createdBy	string	Nee	Indeling: uuid

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een artifact verwijderen

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
artifactId	string	path	Ja	Indeling: uuid

Response (200):

Artifact verwijderd

{
	"deleted": true
}

Veld	Type	Verplicht	Beschrijving
deleted	boolean	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Doorsturen naar een vooraf ondertekende URL om het artifact te downloaden

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
artifactId	string	path	Ja	Indeling: uuid

Fouten:

• 302 Doorsturen naar vooraf ondertekende download-URL
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Artifacts bij een proces weergeven

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt geretourneerd
offset	integer	query	Nee	Aantal items dat wordt overgeslagen

Response (200):

Lijst met procesartifacts

[
	{
		"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"
		}
	}
]

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een vooraf ondertekende S3-upload-URL voor een nieuw procesartifact ophalen

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

Auth: API-sleutel met tenant-scope · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
processId	string	path	Ja	Indeling: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
fileName	string	Ja
mimeType	string	Ja
sizeBytes	number	Ja
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	Nee	Toegestane waarden: modelIcon, processArtifact, doc, levelFrontPageImage Standaard: processArtifact

Response (200):

Vooraf ondertekende upload-URL

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

Veld	Type	Verplicht	Beschrijving
artifactId	string	Ja	Indeling: uuid
originalUrl	string	Ja
thumbnailUrl	string	Ja

Fouten:

• 400 Ongeldige aanvraag, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert dit bestandstype
• 404 Bron niet gevonden
• 409 De aanvraag conflicteert met de huidige status, bijvoorbeeld door een licentieplaatsbeperking of een opnieuw gebruikt id