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

Owned by Technische Redaktion
Last updated: Nov 11, 2021
2 min read
As of Version

product version 2021 Winter | component version 

Request MethodGET
Response FormatJSON
Description

Retrieves the history of the process instance specified by processInstanceId.

Optionally, the following query parameters can be added to the request URL:

Query ParameterTypeDescriptionDefault Value
includeIdentityLinksboolean

Decides whether the identityLinks list is included (true) in the individual tasks' history or not (false).

false
includeCommentsbooleanDecides whether the Comments list is included (true) in the process history or not (false).false

Meaning of HTTP status codes:

HTTP Status CodeDescription
200The process instance history was found and returned.
400Bad request.
403Forbidden.
404The requested process instance specified by processInstanceId was not found.
409Conflict.
415Unsupported media type.
500Internal server error.

Each error is thrown in the response body in JSON format containing an error message and an exception string.

Request HeaderContent-Type: application/json
Request Example

https://<host>/bpm-engine/api/processes/00000000-0000-0000-0000-000000000000/history

Response Example
{
  "tasks": [
    {
      "id": "00000000-0000-0000-0000-000000000123",
      "name": "1st_task",
      "description": "In this case, you have to do several things as they are:\n1. subtask\n2. subtask",
      "assignee": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "owner": null,
      "createTime": "2021-11-01T12:28:46.388Z",
      "claimTime": null,
      "endTime": null,
      "identityLinks": [
        {
          "type": "assignee",
          "userId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
          "groupId": null,
          "timestamp": "2021-11-01T12:28:46.447Z"
        }
      ]
    }
  ],
  "comments": [
    {
      "id": "00000001-0001-0001-0001-000000000001",
      "author": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "message": "This is the first example comment for the first task.",
      "time": "2021-11-02T13:05:29.099Z",
      "processInstanceId": "00000000-0000-0000-0000-000000000000",
      "taskId": "00000000-0000-0000-0000-000000000123"
    }
  ]
}