...
| HTTP Method as of product version | Purpose | Response Format | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Manage Process Definitions | |||||||||||
| GET as of 2021 Autumn | Retrieve a list of process definitions | JSON |
/bpm-engine/api/process-definitions | ||||||||
| GET as of 2021 Autumn | Retrieve a process definition by ID | JSON |
/bpm-engine/api/process-definitions/{processDefinitionID} | ||||||||
Manage Process Instances | |||||||||||
| GET as of 2021 Autumn | Retrieve all processes for the user | JSON |
/bpm-engine/api/processes | ||||||||
| POST as of 2021 Autumn | Start a process | JSON |
/bpm-engine/api/processes | ||||||||
| GET as of 2021 Autumn | Retrieve a process instance | JSON |
/bpm-engine/api/processes/{processInstanceId} | ||||||||
| DELETE as of 2021 Autumn | Delete a process instance | HTTP status code |
/bpm-engine/api/processes/{processInstanceId} | ||||||||
| GET as of 2021 Winter | Retrieve the history of a process instance | JSON |
/bpm-engine/api/processes/{processInstanceId}/history | ||||||||
Manage Tasks | |||||||||||
| GET as of 2021 Autumn | Retrieve a list of tasks | JSON | |||||||||
| GET as of 2021 Autumn | Retrieve a task by ID | JSON |
/bpm-engine/api/tasks/{taskId} | ||||||||
| POST as of 2021 Autumn | Perform an action on a task | JSON |
/bpm-engine/api/tasks/{taskId} | ||||||||
| POST as of 2021 Winter | Create a comment | JSON |
/bpm-engine/api/tasks/{taskId}/comment | ||||||||