History Task
Query

Query for historic task instances

All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The taskVariables and processVariables properties are JSON-arrays containing objects with the format as described here.

post/cmmn-query/historic-task-instances

Request

Request body

startinteger
sizeinteger
sortstring
orderstring
taskIdstring
caseInstanceIdstring
caseInstanceIdWithChildrenstring
caseDefinitionIdstring
caseDefinitionKeystring
caseDefinitionKeyLikestring
caseDefinitionKeyLikeIgnoreCasestring
caseDefinitionKeysstring[]
planItemInstanceIdstring
propagatedStageInstanceIdstring
scopeIdstring
scopeIdsstring[]
withoutScopeIdboolean
taskNamestring
taskNameLikestring
taskNameLikeIgnoreCasestring
taskDescriptionstring
taskDescriptionLikestring
taskDefinitionKeystring
taskDefinitionKeyLikestring
taskCategorystring
taskCategoryInstring[]
taskCategoryNotInstring[]
taskWithoutCategoryboolean
taskDeleteReasonstring
taskDeleteReasonLikestring
taskAssigneestring
taskAssigneeLikestring
taskOwnerstring
taskOwnerLikestring
taskInvolvedUserstring
taskPriorityinteger
taskMinPriorityinteger
taskMaxPriorityinteger
finishedboolean
processFinishedboolean
parentTaskIdstring
dueDatestring date-time
dueDateAfterstring date-time
dueDateBeforestring date-time
withoutDueDateboolean
taskCreatedOnstring date-time
taskCreatedBeforestring date-time
taskCreatedAfterstring date-time
taskCompletedOnstring date-time
taskCompletedBeforestring date-time
taskCompletedAfterstring date-time
includeTaskLocalVariablesboolean
includeProcessVariablesboolean
tenantIdstring
tenantIdLikestring
withoutTenantIdboolean
withoutProcessInstanceIdboolean
taskCandidateGroupstring
ignoreTaskAssigneeboolean
rootScopeIdstring
parentScopeIdstring

Response

Indicates request was successful and the tasks are returned

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.