Qodex.ai

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.

Request Params

KeyDatatypeRequiredDescription
includeProcessVariablesbooleanAn indication if the historic task instance global variables should be returned as well.
includeTaskCommentsbooleanAn indication if the historic task instance comments should be returned as well.
includeTaskAssignmentsbooleanAn indication if the historic task instance assigments should be returned as well.
includeUserIdsbooleanIndication to include OTDS Id instead of email for users in the response.
includeGroupIdsbooleanIndication to include id instead of name for groups and roles in response.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

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":"1983-10-01T14:13:30.693Z"},{"author":"John","id":"e710b009-3397-11ea-b509-eeee0affefe7","message":"SampleMessage","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7","taskId":"f89f1185-3391-11ea-b509-eeee0affefe7","time":"1969-12-05T07:52:01.477Z"}],"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":true},"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":{}}]}