bpm-controller Endpoints

Endpoints of the Web-API gateway for business process management, accessible for any authenticated user.

>> API-WEB Service

The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the BPM-ENGINE Service.


HTTP Method
as of product version
PurposeResponse FormatDescription
GET
as of 2020 Autumn
getProcessInstances JSON

Retrieves a list of process instances corresponding to a specified businessKey set as query parameter.
/api-web/api/bpm/process/instances

POST
as of 2020 Autumn
createProcessInstanceJSON

Creates a process instance specified by the data passed as JSON in the request body.
/api-web/api/bpm/process/instances

DELETE
as of 2020 Autumn
delete dms objectJSON

Deletes the process instance specified by its processInstanceId.
/api-web/api/process/instances/{processInstanceId}

GET
as of 2021 Autumn
get the process instance historyJSON

Retrieves the process instance history for the process instance specified by its processInstanceId.
/api-web/api/process/instances/{processInstanceId}/history

GET
as of 2020 Autumn
getTasksJSON

Retrieves a list of tasks corresponding to the businessKey specified as query parameter.
/api-web/api/bpm/tasks

GET
as of 2021 Winter
getTaskJSON

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

PUT

as of 2020 Autumn

taskActionsHTTP status code

Updates a task specified by its taskId. The task action is defined in JSON format in the request body.
/api-web/api/bpm/tasks/{taskId}