/api/bpm/processes/{id}

Description

To retrieve essential information for a specific process. It provides the following key details for the process:

its history
the associated tasks
the timers - reminder and closure periods (the type property indicates whether it is a reminder or a closure timer)
all activities that were placed into an inbox for the provided process
all users or roles for whom process steps have been inserted into their inboxes

If the passed process is completed (historical process) then the query parameter isComplete must be set to true.

The data in processHistory and in inboxes-tasks sections are sorted by EntryNr (property from the enaio server) which reflects the chronological order. If it is a completed process, then the historical tasks of that process are also sorted in the same way. The data in the tasks section is sorted by ActivityNr (property from the enaio Server) which reflects the chronological order.

The action and state property can have one of the following values according to enaio server manual (enaio server job: wfm.GetHistEntries):

enaio Server Number	BPM action/state constant
1	PrepareProcess
2	StartProcess
3	EndProcess
4	PrepareTask
5	StartTask
6	EndTask
7	CopyTaskVariables
8	HaltTask
9	ReactivateTask
10	StartWorkItem
11	Personalized
12	Depersonalized
13	SaveWorkItem
14	EndWorkItem
15	CreateTimer
16	CancelTimer
17	Remind
18	Delayed
19	StartScript
20	EndScript
21	SysSuspend
22	SetTaskCandidates
23	DeleteTaskCandidates
24	SuspendProcess
25	SuspendTask
26	ResumeProcess
27	ResumeTask
28	RollbackToTask
29	RollbackDeleteTask
30	AdminSaveVariable
31	DepersonalizedByUser
32	DepersonalizedByTimer
33	DepersonalizedByAdmin
34	DepersonalizedBySetCandidates
35	TerminateTask
36	TerminateProcess
37	SetTaskPerformer
38	DeleteTaskPerformer
39	ExecuteLoop
40	StartTestProcess

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Query Parameter

isComplete (boolean): If true, only active processes will be searched for the given id; if false, only historical processes. Default: false.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

/api/bpm/processes/F9AE4EF484AA445CB7100804CCC0F319

/api/bpm/processes/3FC25E4A11674367861FD5BB99DBCF01?isComplete=true

Result
Example

{
    "processHistory": [
        {
            "id": "787048882B67442A86198A658707C745",
            "action": "PREPAREPROCESS",
            "time": "2019-11-26T19:57:07+01:00",
            "userId": "92C7231AC9114818ACC08F2960ACA9F5",
            "userName": "user1",
            "serverName": "WF-System3"
        },
        {
            "id": "25B2AA9EF31A4B4D811133F342995605",
            "action": "STARTPROCESS",
            "time": "2019-11-26T19:57:07+01:00",
            "userId": "92C7231AC9114818ACC08F2960ACA9F5",
            "userName": "user1",
            "serverName": "WF-System3"
        },
        {
            "id": "36E6103E09194D5093A6D5EF7F4AE5C7",
            "action": "REMIND",
            "time": "2019-12-02T10:36:56+01:00",
            "userId": "00000000000000000000000000000003",
            "userName": "WF-System3",
            "serverName": "WF-System3"
        },
        {
            "id": "CDD2178760A14BA18DD196D0E3019EEE",
            "action": "REMIND",
            "time": "2019-12-02T10:36:58+01:00",
            "userId": "00000000000000000000000000000003",
            "userName": "WF-System3",
            "serverName": "WF-System3"
        }
    ],
    "tasks": [
        {
            "id": "CD2FD3D586784CB5AC6407BF3839A871",
            "taskDefinitionId": "00000000000000000000000000000000",
            "name": "StartActivity",
            "owner": "root",
            "createTime": "2019-11-26T19:57:07+01:00",
            "endTime": "2019-11-26T19:57:07+01:00",
            "claimTime": "1970-01-01T01:00:00+01:00",
            "state": "ended",
            "parentTaskId": ""
        },
        {
            "id": "81E238EF1DF7470EB56E305A6D5040F4",
            "taskDefinitionId": "32DEE1D3902E4C2EBD08B23ADE79FCA7",
            "name": "Ad hoc activity",
            "createTime": "2019-11-26T19:57:07+01:00",
            "endTime": "1970-01-01T01:00:00+01:00",
            "claimTime": "1970-01-01T01:00:00+01:00",
            "state": "adHocExecuted",
            "parentTaskId": ""
        },
        {
            "id": "171E46ABDEE14EFB8634F0C9EEF0E688",
            "taskDefinitionId": "C04C78AFD96B48C9BA162D5CE1792015",
            "name": "DisplayName",
            "createTime": "2019-11-29T16:33:12+01:00",
            "endTime": "1970-01-01T01:00:00+01:00",
            "claimTime": "2019-12-03T13:35:31+01:00",
            "state": "personalized",
            "parentTaskId": ""
        },
        {
            "id": "2174ADAD37304F778404BB8E20AFC753",
            "taskDefinitionId": "C04C78AFD96B48C9BA162D5CE1792015",
            "name": "DisplayName",
            "createTime": "2019-11-29T16:33:12+01:00",
            "endTime": "1970-01-01T01:00:00+01:00",
            "claimTime": "2019-12-03T13:35:15+01:00",
            "state": "personalized",
            "parentTaskId": ""
        },
        {
            "id": "21BEB4CAE0AA40B0ADF2FAC08733C575",
            "taskDefinitionId": "C04C78AFD96B48C9BA162D5CE1792015",
            "name": "DisplayName",
            "createTime": "2019-11-26T19:57:08+01:00",
            "endTime": "2019-11-29T16:33:12+01:00",
            "claimTime": "2019-11-29T16:33:11+01:00",
            "state": "ended",
            "parentTaskId": ""
        }
    ],
    "timers": [
        {
            "id": "29EF6C43D97E4B098AE60BCF98DE68DD",
            "fromTaskName": "DisplayName",
            "toTaskName": "DisplayName",
            "type": "reminder"
        },
        {
            "id": "125BB3246B9544AD96086C056AB2F8A8",
            "fromTaskName": "DisplayName",
            "toTaskName": "DisplayName",
            "type": "closure"
        }
    ],
    "inboxes": {
        "tasks": [
            {
                "id": "21BEB4CAE0AA40B0ADF2FAC08733C575",
                "taskDefinitionId": "C04C78AFD96B48C9BA162D5CE1792015",
                "name": "DisplayName"
            },
            {
                "id": "171E46ABDEE14EFB8634F0C9EEF0E688",
                "taskDefinitionId": "C04C78AFD96B48C9BA162D5CE1792015",
                "name": "DisplayName"
            },
            {
                "id": "2174ADAD37304F778404BB8E20AFC753",
                "taskDefinitionId": "C04C78AFD96B48C9BA162D5CE1792015",
                "name": "DisplayName"
            }
        ],
        "users": [
            {
                "userId": "1010454639124D59AFA0DE07A2987776",
                "userName": "user2"
            },
            {
                "userId": "BE2C9475A0E84700BBD45C7C8B2AECF5",
                "userName": "user3"
            },
            {
                "userId": "B1F0DDE80A5543A294BEEDF0C806D623",
                "userName": "user4"
            },
            {
                "userId": "25727D51452D414085BC247A61A26959",
                "userName": "ADHOC"
            },
            {
                "userId": "727A6EA824B543668A4CF56B3EDD98A9",
                "userName": "Adhoc"
            }
        ]
    }
}

[GET] /{id}

/api/bpm/processes/{id}