As of Version

product version 2020 Autumn | component version

Request Method GET

Response Format JSON

Description

Retrieves the process instance history for the process instance specified by its processInstanceId.

Additionally, the boolean query parameter includeComments can be added to the request URL. Default is false.

Response HTTP status codes:

HTTP Status Code	Meaning
`200`	OK
403	Forbidden
404	Not found

Request Example

https://<host>/api-web/api/process/instances/af678-34280fe-3bc/history

no request body

Response Example

200 OK

response body

{
  "tasks": [
    {
      "assignee": {
        "id": "string",
        "title": "string"
      },
      "attachments": [
        "string"
      ],
      "initiator": {
        "id": "string",
        "title": "string"
      },
      "owner": {
        "id": "string",
        "title": "string"
      },
      "processDefinition": {
        "description": "string",
        "id": "string",
        "idPrefix": "string",
        "name": "string"
      },
      "subject": "string",
      "variables": [
        {
          "name": "string",
          "type": "string",
          "value": {}
        }
      ]
    }
  ]
}

Browser not supported