Authorization9

Batch7

Condition1

Decision Definition17

Decision Requirements Definition11

Deployment10

Engine1

Event Subscription2

Execution16

External Task18

Filter14

Group13

Historic Activity Instance5

Historic Batch7

Historic Decision Definition2

Historic Decision Instance5

Historic Decision Requirements Definition1

Historic Detail5

Historic External Task Log6

Historic Identity Link Log2

Historic Incident2

Historic Job Log6

Historic Process Definition3

Historic Process Instance10

Historic Task Instance5

Historic User Operation Log4

Historic Variable Instance7

History Cleanup4

Identity4

Incident6

Job15

Job Definition9

Message1

Metrics3

Migration4

Modification2

Process Definition46

Process Instance25

Process Instance Comment4

Schema Log2

Signal1

Task22

Task Attachment5

Task Comment6

Task Identity Link3

Task Local Variable7

Task Variable7

Telemetry3

Tenant14

User10

Variable Instance6

Version1

Historic Task Instance

Get Tasks (Historic) (POST)

Queries for historic tasks that fulfill the given parameters. This method is slightly more powerful than the Get Tasks (Historic) method because it allows filtering by multiple process or task variables of types String, Number or Boolean. The size of the result set can be retrieved by using the Get Task Count (POST) method.

post/history/task

Request

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

Query parameters

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.

Request body

taskIdstring nullable

Filter by task id.

taskParentTaskIdstring nullable

Filter by parent task id.

processInstanceIdstring nullable

Filter by process instance id.

rootProcessInstanceIdstring nullable

Filter by root process instance id.

processInstanceBusinessKeystring nullable

Filter by process instance business key.

processInstanceBusinessKeyInstring[] nullable

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

processInstanceBusinessKeyLikestring nullable

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

executionIdstring nullable

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

processDefinitionIdstring nullable

Filter by process definition id.

processDefinitionKeystring nullable

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

processDefinitionNamestring nullable

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

caseInstanceIdstring nullable

Filter by case instance id.

caseExecutionIdstring nullable

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

caseDefinitionIdstring nullable

Filter by case definition id.

caseDefinitionKeystring nullable

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

caseDefinitionNamestring nullable

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

activityInstanceIdInstring[] nullable

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

taskNamestring nullable

Restrict to tasks that have the given name.

taskNameLikestring nullable

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

taskDescriptionstring nullable

Restrict to tasks that have the given description.

taskDescriptionLikestring nullable

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

taskDefinitionKeystring nullable

Restrict to tasks that have the given key.

taskDefinitionKeyInstring[] nullable

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

taskDeleteReasonstring nullable

Restrict to tasks that have the given delete reason.

taskDeleteReasonLikestring nullable

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

taskAssigneestring nullable

Restrict to tasks that the given user is assigned to.

taskAssigneeLikestring nullable

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

taskOwnerstring nullable

Restrict to tasks that the given user owns.

taskOwnerLikestring nullable

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

taskPriorityinteger nullable

Restrict to tasks that have the given priority.

assignedboolean nullable

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

unassignedboolean nullable

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

finishedboolean nullable

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

unfinishedboolean nullable

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

processFinishedboolean nullable

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

processUnfinishedboolean nullable

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

taskDueDatestring date-time nullable

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 nullable

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 nullable

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 nullable

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

taskFollowUpDatestring date-time nullable

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 nullable

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 nullable

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 nullable

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 nullable

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 nullable

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 nullable

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[] nullable

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

withoutTenantIdboolean nullable

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

variableNamesIgnoreCaseboolean nullable

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

variableValuesIgnoreCaseboolean nullable

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

taskInvolvedUserstring nullable

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

taskInvolvedGroupstring nullable

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

taskHadCandidateUserstring nullable

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

taskHadCandidateGroupstring nullable

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

withCandidateGroupsboolean nullable

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

withoutCandidateGroupsboolean nullable

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

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.