GET /api-web/api/bpm/processes

As of Version

product version 2020 Autumn | component version

Request Method GET

Response Format JSON

Description

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

Parameter	Type	Description
`businessKey`	string	Only return process instances with the given `businessKey`.
`includeProcessVariables`	boolean	Include process variables in the result.
`page`	integer($int32)	Result page you want to retrieve (0…N). Default is `0` which means the first page.
`processDefinitionKey`	string	Only return process instances with the given process definition key.
`size`	integer($int32)	Number of objects per page.
`sort`	string	Sorting 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 Code	Meaning
`200`	The request was successful and the process-instances are returned
`400`	A 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": {}
        }
      ]
    }
  ]
}