List historic task instances
GET {{baseUrl}}/historic-task-instances?taskId=ut enim labore&processInstanceId=ut enim labore&processInstanceIdWithChildren=ut enim labore&processDefinitionKey=ut enim labore&processDefinitionKeyLike=ut enim labore&processDefinitionId=ut enim labore&processDefinitionName=ut enim labore&processDefinitionNameLike=ut enim labore&processBusinessKey=ut enim labore&processBusinessKeyLike=ut enim labore&executionId=ut enim labore&taskDefinitionKey=ut enim labore&taskDefinitionKeys=ut enim labore&taskName=ut enim labore&taskNameLike=ut enim labore&taskDescription=ut enim labore&taskDescriptionLike=ut enim labore&taskCategory=ut enim labore&taskDeleteReason=ut enim labore&taskDeleteReasonLike=ut enim labore&taskAssignee=ut enim labore&taskAssigneeLike=ut enim labore&taskOwner=ut enim labore&taskOwnerLike=ut enim labore&taskInvolvedUser=ut enim labore&taskPriority=ut enim labore&finished=true&processFinished=true&parentTaskId=ut enim labore&dueDate=1977-02-15T16:48:37.101Z&dueDateAfter=1977-02-15T16:48:37.101Z&dueDateBefore=1977-02-15T16:48:37.101Z&withoutDueDate=true&taskCompletedOn=1977-02-15T16:48:37.101Z&taskCompletedAfter=1977-02-15T16:48:37.101Z&taskCompletedBefore=1977-02-15T16:48:37.101Z&taskCreatedOn=1977-02-15T16:48:37.101Z&taskCreatedBefore=1977-02-15T16:48:37.101Z&taskCreatedAfter=1977-02-15T16:48:37.101Z&includeTaskLocalVariables=true&includeProcessVariables=true&includeTaskAssignments=true&includeTaskComments=true&scopeDefinitionId=ut enim labore&scopeId=ut enim labore&scopeType=ut enim labore&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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"empty":true},"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":"2013-06-15T21:11:03.401Z","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":"1972-05-22T21:15:38.013Z","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-03-03T13:10:04.974Z","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":false}},{"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":"1985-05-26T09:41:57.910Z","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":"1988-05-09T11:04:29.555Z","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":"2019-07-19T03:30:20.464Z","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":"2021-04-19T22:08:47.311Z","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":"1962-12-07T07:28:38.578Z","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":"1989-06-12T02:57:22.514Z","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":false}},{"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":"2007-01-14T18:27:58.953Z","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":"1953-10-31T01:42:19.812Z","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":"1981-12-10T07:17:09.238Z","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}}]]}