GET /api-web/api/bpm/processes

Owned by Technische Redaktion
Nov 12, 2021
As of Version

product version 2020 Autumn | component version 

Request MethodGET
Response FormatJSON
Description

Retrieves a list of process instances corresponding to a specified businessKey set as query parameter.

ParameterTypeDescription
businessKeystringOnly return process instances with the given businessKey.
includeProcessVariablesbooleanInclude process variables in the result.
pageinteger($int32)Result page you want to retrieve (0…N). Default is 0 which means the first page.
processDefinitionKeystringOnly return process instances with the given process definition key.
sizeinteger($int32)Number of objects per page.
sortstringSorting of results either ascending (asc) or descending (desc). Default sort order is ascending.

The response body contains the list of process instances data embedded in a JSON structure. 

Response HTTP status codes:

HTTP Status CodeMeaning
200The request was successful and the process-instances are returned
400A parameter was passed in the wrong format. The status message contains additional information.
Request Example

https://<host>/api-web/api/bpm/process/instances?businessKey=examplekey&includeProcessVariables=true&processDefinitionKey=follow-up

no request body

Response Example

200 OK

response body
{
  "objects": [
    {
      "attachments": [
        "string"
      ],
      "businessKey": "string",
      "deleteReason": "string",
      "durationInMillis": 0,
      "endActivityId": "string",
      "endTime": "string",
      "id": "string",
      "name": "string",
      "processDefinition": {
        "description": "string",
        "id": "string",
        "idPrefix": "string",
        "name": "string"
      },
      "startActivityId": "string",
      "startTime": "string",
      "startUserId": "string",
      "subject": "string",
      "suspended": true,
      "variables": [
        {
          "name": "string",
          "scope": "string",
          "type": "string",
          "value": {}
        }
      ]
    }
  ]
}