/api/bpm/tasks/{id}/history

Description

To retrieve all history entries for a specific task whose id is given in the path. If the query parameter activities is set to true, then all history entries for the specified task are returned with information about the users action (tasks in the inboxes section). The default value of the query parameter activities is false. This endpoint returns the following properties: id, action, time, userId, userName, serverName. If the query parameter activities is set to true, then the following properties are returned: id, action, time, userId, userName, reason.

The reason property has the following values according to enaio server manual (Job: wfm.GetHistWorkItemRelEntriesByActivity):

Server Number (The 11/12 is the action enum value)	Return-Status
0	AddedNormal
1	AddedReminderPeriod
2(11)	AddedAdmin
2(12)	RemovedAdmin
3(11)	AddedScript
3(12)	RemovedScript

For the action property, see [GET] bpm/api/processes/{id}

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Query Parameter

activities (Boolean): to return all history entries for the specified task (tasks in the inboxes section). The default value is false.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

/api/bpm/tasks/F9AE4EF484AA445CB7100804CCC0F319/history

/api/bpm/tasks/F9AE4EF484AA445CB7100804CCC0F319/history?activities=true

Result
Example

{
    "objects": [{
        "id": "8D47A20D79DB488587B51EBF2FFD9BA5",
        "time": "2019-11-26T19:57:09+01:00",
        "userId": "BE2C9475A0E84700BBD45C7C8B2AECF5",
        "userName": "Adhoc",
        "reason": "AddedNormal",
        "action": "SetTaskPerformer"
    },{
        "id": "8D47A20D79DB488587B51EBF2FFD9BA5",
        "time": "2019-11-26T19:57:09+01:00",
        "userId": "727A6EA824B543668A4CF56B3EDD98A9",
        "userName": "Adhoc",
        "reason": "AddedNormal",
        "action": "SetTaskPerformer"
    }]
}

[GET] /history

/api/bpm/tasks/{id}/history