OpenText Developer Cloud public resources API Documentation
Get a process instance
GET {{baseUrl}}/process-instances/:processInstanceId?includeUserIds=false&includeProcessVariables=false
Get a process instance based on the given process instance id.
Body
PARAM
| Key | Datatype | Required | Description |
includeUserIds
|
boolean | Indication to include OTDS Id instead of email for users in the response. | |
includeProcessVariables
|
boolean | An indication if the process instance global variables should be returned as well. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"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": "2014-09-11T07:43:22.823Z"
},
{
"author": "vamsi",
"id": "e710b009-3397-11ea-b509-eeee0affefe7",
"message": "OrderReceived",
"processInstanceId": "f8985abd-3391-11ea-b509-eeee0affefe7",
"time": "2007-03-16T21:45:14.816Z"
}
],
"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": "1944-03-18T00:59:24.885Z",
"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": {}
}
]
} |
Curl
curl -X GET 'baseUrl/process-instances/:processInstanceId?includeUserIds=false&includeProcessVariables=false?includeUserIds=false&includeProcessVariables=false'
ENDPOINTS