List historic task instances
GET {{baseUrl}}/historic-task-instances?taskId=et esse&processInstanceId=et esse&processInstanceIdWithChildren=et esse&processDefinitionKey=et esse&processDefinitionKeyLike=et esse&processDefinitionId=et esse&processDefinitionName=et esse&processDefinitionNameLike=et esse&processBusinessKey=et esse&processBusinessKeyLike=et esse&executionId=et esse&taskDefinitionKey=et esse&taskDefinitionKeys=et esse&taskName=et esse&taskNameLike=et esse&taskDescription=et esse&taskDescriptionLike=et esse&taskCategory=et esse&taskDeleteReason=et esse&taskDeleteReasonLike=et esse&taskAssignee=et esse&taskAssigneeLike=et esse&taskOwner=et esse&taskOwnerLike=et esse&taskInvolvedUser=et esse&taskPriority=et esse&finished=true&processFinished=true&parentTaskId=et esse&dueDate=1967-06-20T13:14:48.573Z&dueDateAfter=1967-06-20T13:14:48.573Z&dueDateBefore=1967-06-20T13:14:48.573Z&withoutDueDate=true&taskCompletedOn=1967-06-20T13:14:48.573Z&taskCompletedAfter=1967-06-20T13:14:48.573Z&taskCompletedBefore=1967-06-20T13:14:48.573Z&taskCreatedOn=1967-06-20T13:14:48.573Z&taskCreatedBefore=1967-06-20T13:14:48.573Z&taskCreatedAfter=1967-06-20T13:14:48.573Z&includeTaskLocalVariables=true&includeProcessVariables=true&includeTaskAssignments=true&includeTaskComments=true&scopeDefinitionId=et esse&scopeId=et esse&scopeType=et esse&filterByCurrentSubscription=true&excludeSubTasks=true&sortEmptyValuesOnTop=true&includeUserIds=false&includeGroupIds=false
List historic task instances.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
taskId | string | An id of the historic task instance. | |
processInstanceId | string | The process instance id of the historic task instance. | |
processInstanceIdWithChildren | string | Selects the historic task instances for the process instance and its children. | |
processDefinitionKey | string | The process definition key of the historic task instance. | |
processDefinitionKeyLike | string | The process definition key of the historic task instance, which matches the given value. | |
processDefinitionId | string | The process definition id of the historic task instance. | |
processDefinitionName | string | The process definition name of the historic task instance. | |
processDefinitionNameLike | string | The process definition name of the historic task instance, which matches the given value. | |
processBusinessKey | string | The process instance business key of the historic task instance. | |
processBusinessKeyLike | string | The process instance business key of the historic task instance that matches the given value. | |
executionId | string | The execution id of the historic task instance. | |
taskDefinitionKey | string | The task definition key for tasks part of a process | |
taskDefinitionKeys | string | The task definition key for tasks part of a process | |
taskName | string | The task name of the historic task instance. | |
taskNameLike | string | The task name with like operator for the historic task instance. | |
taskDescription | string | The task description of the historic task instance. | |
taskDescriptionLike | string | The task description with like operator for the historic task instance. | |
taskCategory | string | Select tasks with the given category. Note that this is the task category, not the category of the process definition (namespace within the BPMN Xml). | |
taskDeleteReason | string | The task delete reason of the historic task instance. | |
taskDeleteReasonLike | string | The task delete reason with like operator for the historic task instance. | |
taskAssignee | string | The assignee of the historic task instance. | |
taskAssigneeLike | string | The assignee with like operator for the historic task instance. This parameter works only with user emails. | |
taskOwner | string | The owner of the historic task instance. | |
taskOwnerLike | string | The owner with like operator for the historic task instance. This parameter works only with user emails. | |
taskInvolvedUser | string | An involved user of the historic task instance | |
taskPriority | string | The priority of the historic task instance. | |
finished | boolean | Indication if the historic task instance is finished. | |
processFinished | boolean | Indication if the process instance of the historic task instance is finished. | |
parentTaskId | string | An optional parent task id of the historic task instance. | |
dueDate | string | Return only historic task instances that have a due date equal this date. | |
dueDateAfter | string | Return only historic task instances that have a due date after this date. | |
dueDateBefore | string | Return only historic task instances that have a due date before this date. | |
withoutDueDate | boolean | Return only historic task instances that have no due-date. When false is provided as value, this parameter is ignored. | |
taskCompletedOn | string | Return only historic task instances that have been completed on this date. | |
taskCompletedAfter | string | Return only historic task instances that have been completed after this date. | |
taskCompletedBefore | string | Return only historic task instances that have been completed before this date. | |
taskCreatedOn | string | Return only historic task instances that were created on this date. | |
taskCreatedBefore | string | Return only historic task instances that were created before this date. | |
taskCreatedAfter | string | Return only historic task instances that were created after this date. | |
includeTaskLocalVariables | boolean | An indication if the historic task instance local variables should be returned as well. | |
includeProcessVariables | boolean | An indication if the historic task instance global variables should be returned as well. | |
includeTaskAssignments | boolean | An indication if the historic task instance assigments should be returned as well. | |
includeTaskComments | boolean | An indication if the historic task instance comments should be returned as well. | |
scopeDefinitionId | string | Only return historic task instances with the given scopeDefinitionId. | |
scopeId | string | Only return historic task instances with the given scopeId. | |
scopeType | string | Only return historic task instances with the given scopeType. | |
filterByCurrentSubscription | boolean | Only return the historic process tasks in the current subscription | |
excludeSubTasks | boolean | Only return historic process tasks that are not a subtask of another task. | |
sortEmptyValuesOnTop | boolean | If true, empty values are ordered at top of list. If false, empty values are ordered at bottom of list | |
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. |
RESPONSES
status: OK
{"links":{"empty":false},"content":[[{"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":"1988-02-28T01:23:01.645Z","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":"2007-04-26T20:32:19.671Z","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":"1977-11-02T13:21:46.680Z","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}},{"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":"1997-02-17T22:05:22.146Z","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":"1994-12-19T05:02:36.724Z","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":"1994-08-29T07:34:21.219Z","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}}],[{"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":"1992-02-23T14:50:12.690Z","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":"2017-03-29T09:11:32.297Z","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":"1978-06-24T03:16:24.017Z","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}},{"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":"1961-08-14T09:13:34.373Z","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":"1971-11-23T02:10:52.187Z","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":"1971-08-06T02:36:35.387Z","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}}]]}