History Task

List historic task instances

For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').

get/cmmn-history/historic-task-instances

Request

Query parameters

taskIdstring

An id of the historic task instance.

caseInstanceIdstring

The case instance id of the historic task instance.

caseInstanceIdWithChildrenstring

Selects the historic task instance of a case instance and its children.

caseDefinitionIdstring

The case definition id of the historic task instance.

propagatedStageInstanceIdstring

Only return tasks which have the given id as propagated stage instance id

withoutScopeIdboolean

If true, only returns historic task instances without a scope id set. If false, the withoutScopeId parameter is ignored.

taskDefinitionKeystring

The task definition key for tasks part of a process

taskNamestring

The task name of the historic task instance.

taskNameLikestring

The task name with like operator for the historic task instance.

taskNameLikeIgnoreCasestring

The task name with like operator for the historic task instance ignoring case.

taskDescriptionstring

The task description of the historic task instance.

taskDescriptionLikestring

The task description with like operator for the historic task instance.

taskCategorystring

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).

taskCategoryInstring

Select tasks with the given categories. Note that this is the task category, not the category of the process definition (namespace within the BPMN Xml).

taskCategoryNotInstring

Select tasks not assigned to the given categories. Note that this is the task category, not the category of the process definition (namespace within the BPMN Xml).

taskWithoutCategorystring

Select tasks with no category assigned. Note that this is the task category, not the category of the process definition (namespace within the BPMN Xml).

taskDeleteReasonstring

The task delete reason of the historic task instance.

taskDeleteReasonLikestring

The task delete reason with like operator for the historic task instance.

taskAssigneestring

The assignee of the historic task instance.

taskAssigneeLikestring

The assignee with like operator for the historic task instance.

taskOwnerstring

The owner of the historic task instance.

taskOwnerLikestring

The owner with like operator for the historic task instance.

taskInvolvedUserstring

An involved user of the historic task instance

taskCandidateGroupstring

Only return tasks that can be claimed by a user in the given group.

taskPrioritystring

The priority of the historic task instance.

finishedboolean

Indication if the historic task instance is finished.

processFinishedboolean

Indication if the process instance of the historic task instance is finished.

parentTaskIdstring

An optional parent task id of the historic task instance.

dueDatestring date-time

Return only historic task instances that have a due date equal this date.

dueDateAfterstring date-time

Return only historic task instances that have a due date after this date.

dueDateBeforestring date-time

Return only historic task instances that have a due date before this date.

withoutDueDateboolean

Return only historic task instances that have no due-date. When false is provided as value, this parameter is ignored.

taskCompletedOnstring date-time

Return only historic task instances that have been completed on this date.

taskCompletedAfterstring date-time

Return only historic task instances that have been completed after this date.

taskCompletedBeforestring date-time

Return only historic task instances that have been completed before this date.

taskCreatedOnstring date-time

Return only historic task instances that were created on this date.

taskCreatedBeforestring date-time

Return only historic task instances that were created before this date.

taskCreatedAfterstring date-time

Return only historic task instances that were created after this date.

includeTaskLocalVariablesboolean

An indication if the historic task instance local variables should be returned as well.

includeProcessVariablesboolean

Indication to include historic process variables in the result.

tenantIdstring

Only return historic task instances with the given tenantId.

tenantIdLikestring

Only return historic task instances with a tenantId like the given value.

withoutTenantIdboolean

If true, only returns historic task instances without a tenantId set. If false, the withoutTenantId parameter is ignored.

withoutProcessInstanceIdboolean

If true, only returns historic task instances without a process instance id set. If false, the withoutProcessInstanceId parameter is ignored.

planItemInstanceIdstring

The plan item instance instance id of the historic task instance.

rootScopeIdstring

Only return case instances which have the given root scope id (that can be a process or case instance ID).

parentScopeIdstring

Only return case instances which have the given parent scope id (that can be a process or case instance ID).

Response

Indicates that historic task instances could be queried.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "variables": [
        {
          "name": "myVariable",
          "type": "string",
          "valueUrl": "http://...."
        }
      ]
    }
  ]
}

Changes

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