/api/bpm/processes/{id}/history

Description

To retrieve all activities processed by the specified user and the respective history entries of the specified history process. This endpoint returns the following properties: id, taskId, taskName, time, reason action. The data in the response are sorted by EntryNr (property from the enaio server) which reflects the chronological order.

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

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 here: [GET] bpm/api/processes/{id}

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Query Parameter

userId (String): User id for which history entries are retrieved. This parameter is mandatory.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

/api/bpm/processes/F9AE4EF484AA445CB7100804CCC0F319/history?userId=E68A04C8054C4BEA9990995A4D629C7F

Result
Example

{
    "objects": [{
        "id": "591BCFA1162F4DC9893C1197E89A9A63",
        "taskId": "87517AB0AD1445E9999038D5C2A0E4A5",
        "taskName": "Initialization",
        "time": "2025-04-08T08:41:07+02:00",
        "reason": "AddedNormal",
        "action": "SetTaskCandidates"
    },
    {
        "id": "72208BBD1A8B40CA8ACB01EBDE8CB529",
        "taskId": "87517AB0AD1445E9999038D5C2A0E4A5",
        "taskName": "Initialization",
        "time": "2025-04-11T15:59:31+02:00",
        "reason": "RemovedAdmin",
        "action": "DeleteTaskCandidates"
    }]
}

[GET] /history

/api/bpm/processes/{id}/history