Qodex.ai

Get a historic task instance

GET {{baseUrl}}/historic-task-instances/:taskId?includeTaskLocalVariables=true&includeProcessVariables=true&includeTaskComments=true&includeTaskAssignments=true&includeUserIds=false&includeGroupIds=false

Get a historic task instance.

Request Params

KeyDatatypeRequiredDescription
includeTaskLocalVariablesbooleanAn indication if the historic task instance local variables should be returned as well.
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.

RESPONSES

status: OK

{"category":"SampleCategory","subscriptionId":"c33fd1c5-65ce-11eb-8176-04ed339d7291","tenantId":"56adec43-d43a-4112-9f49-cd7c64d1d75b","executionId":"68cb0e35-74d7-11ea-a29e-50e08558ee22","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"}],"deleteReason":"Sample Delete Reason","dueDate":"2020-04-13T17:15:11.315+05:30","assignee":"SampleAssignee","formKey":"SampleFormKey","parentTaskId":"692870987-74d7-11ea-a29e-50e08558ee22","claimTime":"1958-11-02T11:31:53.716Z","scopeType":"SampleScopeType","scopeId":"SampleScopeId","assignments":[{"user":"testCandidate@test.com","type":"assignee","group":"testgroup"},{"user":"testCandidate@test.com","type":"assignee","group":"testgroup"}],"name":"Sample Task","priority":5,"id":"69287079-74d7-11ea-a29e-50e08558ee22","owner":"SampleOwner","description":"Sample Task Description","startTime":"2020-04-02T17:15:11.315+05:30","comments":[{"taskId":"f89f1185-3391-11ea-b509-eeee0affefe7","author":"user@opentext.com","message":"SampleMessage","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1946-01-30T18:11:05.203Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"},{"taskId":"f89f1185-3391-11ea-b509-eeee0affefe7","author":"user@opentext.com","message":"SampleMessage","id":"e710b009-3397-11ea-b509-eeee0affefe7","time":"1970-06-24T10:08:52.378Z","processInstanceId":"f8985abd-3391-11ea-b509-eeee0affefe7"}],"taskDefinitionKey":"SampleTaskDefinitionKey","durationInMillis":307407,"workTimeInMillis":509346,"scopeDefinitionId":"SampleScopeDefinitionId","processInstanceId":"68cb0e33-74d7-11ea-a29e-50e08558ee22","processDefinitionId":"SampleDeployment:3:668738b2-74d7-11ea-a29e-50e08558ee22","links":{"empty":true}}