Versions Compared

Old Version 2

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idrDEV

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje01 NOV 20212021 Wintercreated
Agnieszka11 NOV 20212021 WinterrLANG



As of Version

product version 2021 Winter | component version 

Request MethodGET
Response FormatJSON
Description


Excerpt

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 Requestrequest.
403Forbidden.
404The requested process instance specified by processInstanceId was not found.
409Conflict.
415Unsupported Media Typemedia type.
500Internal Server Errorserver 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


Code Block
languageyml
{
  "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"
    }
  ]
}


...