Sign in
Historic Task Instance

Get Tasks (Historic)

Queries for historic tasks that fulfill the given parameters. The size of the result set can be retrieved by using the Get Task Count method.

get/history/task

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/task
  • Auth: HTTP basic

Query parameters

taskIdstring

Filter by task id.

taskParentTaskIdstring

Filter by parent task id.

processInstanceIdstring

Filter by process instance id.

rootProcessInstanceIdstring

Filter by root process instance id.

processInstanceBusinessKeystring

Filter by process instance business key.

processInstanceBusinessKeyInstring

Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list.

processInstanceBusinessKeyLikestring

Filter by process instance business key that has the parameter value as a substring.

executionIdstring

Filter by the id of the execution that executed the task.

processDefinitionIdstring

Filter by process definition id.

processDefinitionKeystring

Restrict to tasks that belong to a process definition with the given key.

processDefinitionNamestring

Restrict to tasks that belong to a process definition with the given name.

caseInstanceIdstring

Filter by case instance id.

caseExecutionIdstring

Filter by the id of the case execution that executed the task.

caseDefinitionIdstring

Filter by case definition id.

caseDefinitionKeystring

Restrict to tasks that belong to a case definition with the given key.

caseDefinitionNamestring

Restrict to tasks that belong to a case definition with the given name.

activityInstanceIdInstring

Only include tasks which belong to one of the passed comma-separated activity instance ids.

taskNamestring

Restrict to tasks that have the given name.

taskNameLikestring

Restrict to tasks that have a name with the given parameter value as substring.

taskDescriptionstring

Restrict to tasks that have the given description.

taskDescriptionLikestring

Restrict to tasks that have a description that has the parameter value as a substring.

taskDefinitionKeystring

Restrict to tasks that have the given key.

taskDefinitionKeyInstring

Restrict to tasks that have one of the passed comma-separated task definition keys.

taskDeleteReasonstring

Restrict to tasks that have the given delete reason.

taskDeleteReasonLikestring

Restrict to tasks that have a delete reason that has the parameter value as a substring.

taskAssigneestring

Restrict to tasks that the given user is assigned to.

taskAssigneeLikestring

Restrict to tasks that are assigned to users with the parameter value as a substring.

taskOwnerstring

Restrict to tasks that the given user owns.

taskOwnerLikestring

Restrict to tasks that are owned by users with the parameter value as a substring.

taskPriorityinteger

Restrict to tasks that have the given priority.

assignedboolean

If set to true, restricts the query to all tasks that are assigned.

unassignedboolean

If set to true, restricts the query to all tasks that are unassigned.

finishedboolean

Only include finished tasks. Value may only be true, as false is the default behavior.

unfinishedboolean

Only include unfinished tasks. Value may only be true, as false is the default behavior.

processFinishedboolean

Only include tasks of finished processes. Value may only be true, as false is the default behavior.

processUnfinishedboolean

Only include tasks of unfinished processes. Value may only be true, as false is the default behavior.

taskDueDatestring date-time

Restrict to tasks that are due on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskDueDateBeforestring date-time

Restrict to tasks that are due before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskDueDateAfterstring date-time

Restrict to tasks that are due after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

withoutTaskDueDateboolean

Only include tasks which have no due date. Value may only be true, as false is the default behavior.

taskFollowUpDatestring date-time

Restrict to tasks that have a followUp date on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskFollowUpDateBeforestring date-time

Restrict to tasks that have a followUp date before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskFollowUpDateAfterstring date-time

Restrict to tasks that have a followUp date after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

startedBeforestring date-time

Restrict to tasks that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

startedAfterstring date-time

Restrict to tasks that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedBeforestring date-time

Restrict to tasks that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedAfterstring date-time

Restrict to tasks that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

tenantIdInstring

Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids.

withoutTenantIdboolean

Only include historic task instances that belong to no tenant. Value may only be true, as false is the default behavior.

taskVariablesstring

Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are:

  • eq - equal to;
  • neq - not equal to;
  • gt - greater than;
  • gteq - greater than or equal to;
  • lt - lower than;
  • lteq - lower than or equal to;
  • like.

key and value may not contain underscore or comma characters.

processVariablesstring

Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are:

  • eq - equal to;
  • neq - not equal to;
  • gt - greater than;
  • gteq - greater than or equal to;
  • lt - lower than;
  • lteq - lower than or equal to;
  • like;
  • notLike.

key and value may not contain underscore or comma characters.

variableNamesIgnoreCaseboolean

Match the variable name provided in taskVariables and processVariables case- insensitively. If set to true variableName and variablename are treated as equal.

variableValuesIgnoreCaseboolean

Match the variable value provided in taskVariables and processVariables case- insensitively. If set to true variableValue and variablevalue are treated as equal.

taskInvolvedUserstring

Restrict to tasks with a historic identity link to the given user.

taskInvolvedGroupstring

Restrict to tasks with a historic identity link to the given group.

taskHadCandidateUserstring

Restrict to tasks with a historic identity link to the given candidate user.

taskHadCandidateGroupstring

Restrict to tasks with a historic identity link to the given candidate group.

withCandidateGroupsboolean

Only include tasks which have a candidate group. Value may only be true, as false is the default behavior.

withoutCandidateGroupsboolean

Only include tasks which have no candidate group. Value may only be true, as false is the default behavior.

sortBy'taskId' | 'activityInstanceId' | 'processDefinitionId' | 'processInstanceId' | 'executionId' | 'duration' | 'endTime' | 'startTime' | 'taskName' | 'taskDescription' | 'assignee' | 'owner' | 'dueDate' | 'followUpDate' | 'deleteReason' | 'taskDefinitionKey' | 'priority' | 'caseDefinitionId' | 'caseInstanceId' | 'caseExecutionId' | 'tenantId'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

idstring nullable

The task id.

processDefinitionKeystring nullable

The key of the process definition the task belongs to.

processDefinitionIdstring nullable

The id of the process definition the task belongs to.

processInstanceIdstring nullable

The id of the process instance the task belongs to.

executionIdstring nullable

The id of the execution the task belongs to.

caseDefinitionKeystring nullable

The key of the case definition the task belongs to.

caseDefinitionIdstring nullable

The id of the case definition the task belongs to.

caseInstanceIdstring nullable

The id of the case instance the task belongs to.

caseExecutionIdstring nullable

The id of the case execution the task belongs to.

activityInstanceIdstring nullable

The id of the activity that this object is an instance of.

namestring nullable

The task name.

descriptionstring nullable

The task's description.

deleteReasonstring nullable

The task's delete reason.

ownerstring nullable

The owner's id.

assigneestring nullable

The assignee's id.

startTimestring date-time nullable

The time the task was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

endTimestring date-time nullable

The time the task ended. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

durationinteger nullable

The time the task took to finish (in milliseconds).

taskDefinitionKeystring nullable

The task's key.

priorityinteger nullable

The task's priority.

duestring date-time nullable

The task's due date. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

parentTaskIdstring nullable

The id of the parent task, if this task is a subtask.

followUpstring date-time nullable

The follow-up date for the task. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

tenantIdstring nullable

The tenant id of the task instance.

removalTimestring date-time nullable

The time after which the task should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the process containing this task.

taskStatestring nullable

The task's state.

Changes

No recorded changes to this operation across all 1 revision of this API.