Qodex.ai

List process instances

GET {{baseUrl}}/process-instances?id=voluptate elit&name=voluptate elit&nameLike=voluptate elit&nameLikeIgnoreCase=voluptate elit&processDefinitionKey=voluptate elit&processDefinitionId=voluptate elit&processDefinitionCategory=voluptate elit&processDefinitionVersion=-98125607&businessKey=voluptate elit&startedBy=voluptate elit&startedBefore=1951-08-14T20:08:23.047Z&startedAfter=1951-08-14T20:08:23.047Z&involvedUser=voluptate elit&suspended=true&superProcessInstanceId=voluptate elit&subProcessInstanceId=voluptate elit&excludeSubprocesses=true&includeProcessVariables=true&callbackId=voluptate elit&callbackType=voluptate elit&dueOn=1951-08-14T20:08:23.047Z&dueBefore=1951-08-14T20:08:23.047Z&dueAfter=1951-08-14T20:08:23.047Z&offset=voluptate elit&count=voluptate elit&filterByCurrentSubscription=true&sort=id&order=asc&includeUserIds=false&includeProcessComments=true&sortEmptyValuesOnTop=true

List process instances.

Request Params

KeyDatatypeRequiredDescription
idstringOnly return process instance with the given process instance id.
namestringOnly return process instances with the given name.
nameLikestringOnly return process instances like the given name.
nameLikeIgnoreCasestringOnly return process instances like the given name ignoring case.
processDefinitionKeystringOnly return process instances with the given process definition key.
processDefinitionIdstringOnly return process instances with the given process definition id.
processDefinitionCategorystringOnly return process instances with the given process definition category.
processDefinitionVersionnumberOnly return process instances with the given process definition version.
businessKeystringOnly return process instances with the given subscription id.
startedBystringOnly return process instances started by the given user.
startedBeforestringOnly return process instances started before the given date.
startedAfterstringOnly return process instances started after the given date.
involvedUserstringOnly return process instances in which the given user is involved.
suspendedbooleanIf true, only return process instance which are suspended. If false, only return process instances which are not suspended (active).
superProcessInstanceIdstringOnly return process instances which have the given super process-instance id (for processes that have a call-activities).
subProcessInstanceIdstringOnly return process instances which have the given sub process-instance id (for processes started as a call-activity).
excludeSubprocessesbooleanReturn only process instances which are not sub processes.
includeProcessVariablesbooleanIndication to include process variables in the result.
callbackIdstringOnly return process instances with the given callbackId.
callbackTypestringOnly return process instances with the given callbackType.
dueOnstringOnly return process instances which are due on the given date.
dueBeforestringOnly return process instances which are due before the given date.
dueAfterstringOnly return process instances which are due after the given date.
offsetstringStart position value in the list of items, used for pagination.
countstringNumber of items to be limited in the response, used for pagination. By default the count value is set to 10.
filterByCurrentSubscriptionbooleanOnly return the process instances in the current subscription
sortstringProperty to sort on, to be used together with the order.
orderstringOrder to be used together with the sort.
includeUserIdsbooleanIndication to include OTDS Id instead of email for users in the response.
includeProcessCommentsbooleanIndication to include process comments in the result.
sortEmptyValuesOnTopbooleanIf true, empty values are ordered at top of list. If false, empty values are ordered at bottom of list

RESPONSES

status: OK

{"content":[[{"activityId":"SampleActivityId","businessKey":"SampleBusinessKey","callbackId":"SampleCallBackId","callbackType":"SampleCallBackType","comments":[{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"1944-12-06T10:03:34.052Z"},{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"2011-05-03T22:17:25.703Z"}],"completed":false,"dueDate":"2020-04-17T10:17:43.902+0000","ended":false,"id":"f8985abd-3391-11ea-b509-eeee0affefe7","links":{"empty":false},"name":"Sample Process","processDefinitionName":"SampleDefinitionName","startTime":"1947-03-17T07:12:06.923Z","startUserId":"SampleUser","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","superProcessInstanceId":"f8985ab8-3391-11ea-b509-eeee0affefe7","suspended":false,"tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","variables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}}]},{"activityId":"SampleActivityId","businessKey":"SampleBusinessKey","callbackId":"SampleCallBackId","callbackType":"SampleCallBackType","comments":[{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"1998-12-26T12:58:37.262Z"},{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"2003-10-24T10:06:16.453Z"}],"completed":false,"dueDate":"2020-04-17T10:17:43.902+0000","ended":false,"id":"f8985abd-3391-11ea-b509-eeee0affefe7","links":{"empty":false},"name":"Sample Process","processDefinitionName":"SampleDefinitionName","startTime":"1957-06-04T18:21:48.141Z","startUserId":"SampleUser","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","superProcessInstanceId":"f8985ab8-3391-11ea-b509-eeee0affefe7","suspended":false,"tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","variables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}}]}],[{"activityId":"SampleActivityId","businessKey":"SampleBusinessKey","callbackId":"SampleCallBackId","callbackType":"SampleCallBackType","comments":[{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"1978-01-01T09:57:54.920Z"},{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"2013-01-10T08:28:19.182Z"}],"completed":false,"dueDate":"2020-04-17T10:17:43.902+0000","ended":false,"id":"f8985abd-3391-11ea-b509-eeee0affefe7","links":{"empty":true},"name":"Sample Process","processDefinitionName":"SampleDefinitionName","startTime":"1956-11-09T12:01:14.918Z","startUserId":"SampleUser","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","superProcessInstanceId":"f8985ab8-3391-11ea-b509-eeee0affefe7","suspended":false,"tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","variables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}}]},{"activityId":"SampleActivityId","businessKey":"SampleBusinessKey","callbackId":"SampleCallBackId","callbackType":"SampleCallBackType","comments":[{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"1998-10-11T17:19:21.402Z"},{"author":"vamsi","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"OrderReceived","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","time":"1950-04-03T15:11:00.574Z"}],"completed":false,"dueDate":"2020-04-17T10:17:43.902+0000","ended":false,"id":"f8985abd-3391-11ea-b509-eeee0affefe7","links":{"empty":true},"name":"Sample Process","processDefinitionName":"SampleDefinitionName","startTime":"1946-07-31T18:32:47.009Z","startUserId":"SampleUser","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","superProcessInstanceId":"f8985ab8-3391-11ea-b509-eeee0affefe7","suspended":false,"tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","variables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string","value":{}}]}]],"links":{"empty":true}}