GET /api-web/api/process/instances/{processInstanceId}/history

Owned by Technische Redaktion
Last updated: Nov 28, 2022
As of Version

product version 2020 Autumn | component version 

Request MethodGET
Response FormatJSON
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 CodeMeaning
200OK
403Forbidden
404Not 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": {}
        }
      ]
    }
  ]
}