BPM Engine Endpoints
These endpoints allow the management of workflow processes and tasks.
| 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 | Retrieves a list of process definitions matching the conditions defined in various query parameters. |
| GET as of 2021 Autumn | Retrieve a process definition by ID | JSON | Retrieves the process definitions specified by |
Manage Process Instances | |||
| GET as of 2021 Autumn | Retrieve all processes for the user | JSON | Retrieves a list of processes of the currently active user that are matching the conditions defined in various query parameters. |
| POST as of 2021 Autumn | Start a process | JSON | Starts a process specified in a JSON structure in the request body. |
| GET as of 2021 Autumn | Retrieve a process instance | JSON | Retrieves the process instance specified by |
| DELETE as of 2021 Autumn | Delete a process instance | HTTP status code | Deletes the process instance specified by |
| GET as of 2021 Winter | Retrieve the history of a process instance | JSON | Retrieves the history of the process instance specified by |
Manage Tasks | |||
| GET as of 2021 Autumn | Retrieve a list of tasks | JSON | Retrieves a list of tasks of the currently active user that are matching the conditions defined in various query parameters. |
| GET as of 2021 Autumn | Retrieve a task by ID | JSON | Retrieves the task specified by |
| POST as of 2021 Autumn | Perform an action on a task | JSON | Performs an action defined in the request body on the task specified by |
| POST as of 2021 Winter | Create a comment | JSON | Creates a comment with the message specified in the plain text request body for the task specified by |