GET /bpm-engine/api/processes/{processInstanceId}

As of Version

product version 2021 Autumn | component version

Request Method POST

Response Format JSON

Description

Retrieves the process instance specified by processInstanceId.

Optionally, the boolean query parameter includeProcessVariables can be added to the request URL in order to include process variables in the result. Default is false.

Meaning of HTTP status codes:

HTTP Status Code	Description
200	The process instance was found and returned.
401	The calling user is not authorized.
404	The requested process instance specified by `processInstanceId` was not found.

Request Header Content-Type: application/json

Request Example

https://<host>/bpm-engine/api/processes/187

Response Example

{
  "hasMoreItems": true,
  "numItems": 50,
  "objects": [
    {
      "businessKey": "myBusinessKey",
      "completed": true,
      "id": 187,
      "name": "myProcessInstanceName",
      "processDefinitionDescription": "A process definition description",
      "processDefinitionId": "oneTaskProcess:1:00000000-0000-0000-0000-000000000000",
      "processDefinitionName": "A process definition name",
      "startTime": "2018-04-17T10:17:43.902+0000",
      "startUserId": "user0001",
      "suspended": true,
      "variables": [
        {
          "name": "myVariable",
          "scope": "myScope",
          "type": "myType",
          "value": "test",
          "valueUrl": "http://...."
        }
      ]
    }
  ]
}