Qodex.ai

List historic process instances

GET {{baseUrl}}/historic-process-instances?processInstanceId=ut enim labore&processInstanceName=ut enim labore&processInstanceNameLike=ut enim labore&processInstanceNameLikeIgnoreCase=ut enim labore&processDefinitionKey=ut enim labore&processDefinitionId=ut enim labore&processDefinitionName=ut enim labore&processDefinitionCategory=ut enim labore&processDefinitionVersion=ut enim labore&deploymentId=ut enim labore&businessKey=ut enim labore&businessKeyLike=ut enim labore&involvedUser=ut enim labore&finished=true&superProcessInstanceId=ut enim labore&excludeSubprocesses=true&finishedAfter=1977-02-15T16:48:37.101Z&finishedBefore=1977-02-15T16:48:37.101Z&startedAfter=1977-02-15T16:48:37.101Z&startedBefore=1977-02-15T16:48:37.101Z&startedBy=ut enim labore&includeProcessVariables=true&filterByCurrentSubscription=true&dueOn=1977-02-15T16:48:37.101Z&dueBefore=1977-02-15T16:48:37.101Z&dueAfter=1977-02-15T16:48:37.101Z&callbackId=ut enim labore&callbackType=ut enim labore&sortEmptyValuesOnTop=true&includeUserIds=false&includeProcessComments=true

List historic process instances

Request Params

KeyDatatypeRequiredDescription
processInstanceIdstringAn id of the historic process instance.
processInstanceNamestringA name of the historic process instance.
processInstanceNameLikestringA name of the historic process instance used in a like query.
processInstanceNameLikeIgnoreCasestringA name of the historic process instance used in a like query ignoring case.
processDefinitionKeystringThe process definition key of the historic process instance.
processDefinitionIdstringThe process definition id of the historic process instance.
processDefinitionNamestringThe process definition name of the historic process instance.
processDefinitionCategorystringThe process definition category of the historic process instance.
processDefinitionVersionstringThe process definition version of the historic process instance.
deploymentIdstringThe deployment id of the historic process instance.
businessKeystringThe business key of the historic process instance.
businessKeyLikestringOnly return instances with a businessKey like this key.
involvedUserstringAn involved user of the historic process instance.
finishedbooleanIndication if the historic process instance is finished.
superProcessInstanceIdstringAn optional parent process id of the historic process instance.
excludeSubprocessesbooleanReturn only historic process instances which are not sub processes.
finishedAfterstringReturn only historic process instances that were finished after this date.
finishedBeforestringReturn only historic process instances that were finished before this date.
startedAfterstringReturn only historic process instances that were started after this date.
startedBeforestringReturn only historic process instances that were started before this date.
startedBystringReturn only historic process instances that were started by this user.
includeProcessVariablesbooleanAn indication if the historic process instance variables should be returned as well.
filterByCurrentSubscriptionbooleanOnly return the process instances in the current subscription
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.
callbackIdstringOnly return instances with the given callbackId.
callbackTypestringOnly return instances with the given callbackType.
sortEmptyValuesOnTopbooleanIf true, empty values are ordered at top of list. If false, empty values are ordered at bottom of list
includeUserIdsbooleanIndication to include OTDS Id instead of email for users in the response.
includeProcessCommentsbooleanIndication to include process comments in the result.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"links":{"empty":false},"content":[[{"subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","endTime":"2020-04-02T17:20:18.722+05:30","variables":[{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"},{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"}],"callbackId":"SampleCallBackId","startUserId":"SampleUser","deleteReason":"SampleDeleteReason","endActivityId":"endEvent","callbackType":"SampleCallBackType","dueDate":"2021-04-02T17:20:18.722+05:30","referenceId":"SampleReferenceId","startActivityId":"startEvent","businessKey":"SampleBusinessKey","referenceType":"event-to-bpmn-2.0-process","name":"Sample Process","id":"68cb0e33-74d7-11ea-a29e-50e08558ee22","startTime":"2020-04-02T17:15:11.315+05:30","comments":[{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1988-01-08T21:44:12.770Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"},{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1965-04-05T16:04:10.610Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"}],"processDefinitionDescription":"Sample Process Definition Description","superProcessInstanceId":"53baeda7-6f40-11ea-8b7c-50e08558ee22","durationInMillis":86400056,"processDefinitionName":"Sample Process Definition","processDefinitionId":"SampleDeployment:3:668738b2-74d7-11ea-a29e-50e08558ee22","links":{"empty":false}},{"subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","endTime":"2020-04-02T17:20:18.722+05:30","variables":[{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"},{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"}],"callbackId":"SampleCallBackId","startUserId":"SampleUser","deleteReason":"SampleDeleteReason","endActivityId":"endEvent","callbackType":"SampleCallBackType","dueDate":"2021-04-02T17:20:18.722+05:30","referenceId":"SampleReferenceId","startActivityId":"startEvent","businessKey":"SampleBusinessKey","referenceType":"event-to-bpmn-2.0-process","name":"Sample Process","id":"68cb0e33-74d7-11ea-a29e-50e08558ee22","startTime":"2020-04-02T17:15:11.315+05:30","comments":[{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1992-04-26T21:49:23.532Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"},{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"2018-02-14T14:24:50.954Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"}],"processDefinitionDescription":"Sample Process Definition Description","superProcessInstanceId":"53baeda7-6f40-11ea-8b7c-50e08558ee22","durationInMillis":86400056,"processDefinitionName":"Sample Process Definition","processDefinitionId":"SampleDeployment:3:668738b2-74d7-11ea-a29e-50e08558ee22","links":{"empty":true}}],[{"subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","endTime":"2020-04-02T17:20:18.722+05:30","variables":[{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"},{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"}],"callbackId":"SampleCallBackId","startUserId":"SampleUser","deleteReason":"SampleDeleteReason","endActivityId":"endEvent","callbackType":"SampleCallBackType","dueDate":"2021-04-02T17:20:18.722+05:30","referenceId":"SampleReferenceId","startActivityId":"startEvent","businessKey":"SampleBusinessKey","referenceType":"event-to-bpmn-2.0-process","name":"Sample Process","id":"68cb0e33-74d7-11ea-a29e-50e08558ee22","startTime":"2020-04-02T17:15:11.315+05:30","comments":[{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"2012-10-24T03:30:51.759Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"},{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1943-09-01T05:17:27.284Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"}],"processDefinitionDescription":"Sample Process Definition Description","superProcessInstanceId":"53baeda7-6f40-11ea-8b7c-50e08558ee22","durationInMillis":86400056,"processDefinitionName":"Sample Process Definition","processDefinitionId":"SampleDeployment:3:668738b2-74d7-11ea-a29e-50e08558ee22","links":{"empty":false}},{"subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","endTime":"2020-04-02T17:20:18.722+05:30","variables":[{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"},{"name":"SampleVariable","type":"string","value":{},"encryption":false,"scope":"local"}],"callbackId":"SampleCallBackId","startUserId":"SampleUser","deleteReason":"SampleDeleteReason","endActivityId":"endEvent","callbackType":"SampleCallBackType","dueDate":"2021-04-02T17:20:18.722+05:30","referenceId":"SampleReferenceId","startActivityId":"startEvent","businessKey":"SampleBusinessKey","referenceType":"event-to-bpmn-2.0-process","name":"Sample Process","id":"68cb0e33-74d7-11ea-a29e-50e08558ee22","startTime":"2020-04-02T17:15:11.315+05:30","comments":[{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1965-09-12T01:00:40.553Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"},{"author":"vamsi","message":"OrderReceived","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1977-02-05T00:05:20.795Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"}],"processDefinitionDescription":"Sample Process Definition Description","superProcessInstanceId":"53baeda7-6f40-11ea-8b7c-50e08558ee22","durationInMillis":86400056,"processDefinitionName":"Sample Process Definition","processDefinitionId":"SampleDeployment:3:668738b2-74d7-11ea-a29e-50e08558ee22","links":{"empty":false}}]]}