BPM Engine Endpoints

Owned by Technische Redaktion
Dec 01, 2022
1 min read


These endpoints allow the management of workflow processes and tasks.

HTTP Method
as of product version		PurposeResponse FormatDescription

Manage Process Definitions

GET
as of 2021 Autumn
Retrieve a list of process definitionsJSON

Retrieves a list of process definitions matching the conditions defined in various query parameters.
/bpm-engine/api/process-definitions

GET
as of 2021 Autumn
Retrieve a process definition by IDJSON

Retrieves the process definitions specified by processDefinitionId.
/bpm-engine/api/process-definitions/{processDefinitionID}


Manage Process Instances

GET
as of 2021 Autumn
Retrieve all processes for the userJSON

Retrieves a list of processes of the currently active user that are matching the conditions defined in various query parameters.
/bpm-engine/api/processes

POST
as of 2021 Autumn
Start a processJSON

Starts a process specified in a JSON structure in the request body.
/bpm-engine/api/processes

GET
as of 2021 Autumn
Retrieve a process instanceJSON

Retrieves the process instance specified by processInstanceId.
/bpm-engine/api/processes/{processInstanceId}

DELETE
as of 2021 Autumn
Delete a process instanceHTTP status code

Deletes the process instance specified by processInstanceId.
/bpm-engine/api/processes/{processInstanceId}

GET
as of 2021 Winter		Retrieve the history of a process instanceJSON

Retrieves the history of the process instance specified by processInstanceId.
/bpm-engine/api/processes/{processInstanceId}/history


Manage Tasks

GET
as of 2021 Autumn
Retrieve a list of tasksJSON

Retrieves a list of tasks of the currently active user that are matching the conditions defined in various query parameters.
/bpm-engine/api/tasks

GET
as of 2021 Autumn
Retrieve a task by IDJSON

Retrieves the task specified by taskId.
/bpm-engine/api/tasks/{taskId}

POST
as of 2021 Autumn
Perform an action on a taskJSON

Performs an action defined in the request body on the task specified by taskId.
/bpm-engine/api/tasks/{taskId}

POST
as of 2021 Winter		Create a commentJSON

Creates a comment with the message specified in the plain text request body for the task specified by taskId. It will be included in the process instance's history.
/bpm-engine/api/tasks/{taskId}/comment