OpenText Developer Cloud public resources API Documentation
Get a task
GET {{baseUrl}}/tasks/:taskId?includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&includeUserIds=false&includeGroupIds=false
Retrieve a task based on given task id.
Body
PARAM
| Key | Datatype | Required | Description |
includeProcessVariables
|
boolean | An indication if the historic task instance global variables should be returned as well. | |
includeTaskComments
|
boolean | An indication if the historic task instance comments should be returned as well. | |
includeTaskAssignments
|
boolean | An indication if the historic task instance assigments should be returned as well. | |
includeUserIds
|
boolean | Indication to include OTDS Id instead of email for users in the response. | |
includeGroupIds
|
boolean | Indication to include id instead of name for groups and roles in response. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"assignee": "John",
"assignments": [
{
"group": "testgroup",
"type": "assignee",
"user": "testCandidate@test.com"
},
{
"group": "testgroup",
"type": "assignee",
"user": "testCandidate@test.com"
}
],
"category": "SampleCategory",
"claimTime": "2018-04-17T10:17:43.902+0000",
"comments": [
{
"author": "John",
"id": "e710b009-3397-11ea-b509-eeee0affefe7",
"message": "SampleMessage",
"processInstanceId": "f8985abd-3391-11ea-b509-eeee0affefe7",
"taskId": "f89f1185-3391-11ea-b509-eeee0affefe7",
"time": "2011-11-06T15:23:15.227Z"
},
{
"author": "John",
"id": "e710b009-3397-11ea-b509-eeee0affefe7",
"message": "SampleMessage",
"processInstanceId": "f8985abd-3391-11ea-b509-eeee0affefe7",
"taskId": "f89f1185-3391-11ea-b509-eeee0affefe7",
"time": "1957-10-10T09:42:30.260Z"
}
],
"createTime": "2018-04-17T10:17:43.902+0000",
"delegationState": "pending",
"description": "Task description",
"dueDate": "2018-04-17T10:17:43.902+0000",
"executionId": "10b19e54-1756-11ea-ad8a-eeee0aff2e87",
"formKey": "SampleFormKey",
"id": "10c19684-1756-11ea-ad8a-eeee0aff2e87",
"links": {
"empty": false
},
"name": "Sample Task",
"owner": "John",
"parentTaskId": "10c196e4-1756-11ea-ad8a-eeee0aff2e87",
"priority": 5,
"processInstanceId": "f8985abd-3391-11ea-b509-eeee0affefe7",
"subscriptionId": "9b4c9575-e116-47df-8b7b-7948a1639803",
"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/tasks/:taskId?includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&includeUserIds=false&includeGroupIds=false?includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&includeUserIds=false&includeGroupIds=false'
ENDPOINTS