Tasks
Query

Query for tasks

All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), 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 task and process variables. The taskVariables and processInstanceVariables are both JSON-arrays containing objects with the format as described here.

post/cmmn-query/tasks

Request

Request body

startinteger
sizeinteger
sortstring
orderstring
taskIdstring
namestring
nameLikestring
nameLikeIgnoreCasestring
descriptionstring
descriptionLikestring
priorityinteger
minimumPriorityinteger
maximumPriorityinteger
assigneestring
assigneeLikestring
ownerstring
ownerLikestring
unassignedboolean
delegationStatestring
candidateUserstring
candidateGroupstring
candidateGroupInstring[]
ignoreAssigneeboolean
involvedUserstring
caseInstanceIdstring
caseInstanceIdWithChildrenstring
planItemInstanceIdstring
propagatedStageInstanceIdstring
scopeIdstring
scopeIdsstring[]
withoutScopeIdboolean
subScopeIdstring
scopeTypestring
caseDefinitionIdstring
caseDefinitionKeystring
caseDefinitionKeyLikestring
caseDefinitionKeyLikeIgnoreCasestring
caseDefinitionKeysstring[]
createdOnstring date-time
createdBeforestring date-time
createdAfterstring date-time
excludeSubTasksboolean
taskDefinitionKeystring
taskDefinitionKeyLikestring
dueDatestring date-time
dueBeforestring date-time
dueAfterstring date-time
withoutDueDateboolean
activeboolean
includeTaskLocalVariablesboolean
includeProcessVariablesboolean
tenantIdstring
tenantIdLikestring
withoutTenantIdboolean
withoutProcessInstanceIdboolean
candidateOrAssignedstring
categorystring
rootScopeIdstring
parentScopeIdstring
categoryInstring[]
categoryNotInstring[]
withoutCategoryboolean

Response

Indicates request was successful and the tasks are returned.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "8",
      "url": "http://localhost:8182/cmmn-runtime/tasks/8",
      "owner": "owner",
      "assignee": "kermit",
      "delegationState": "pending",
      "name": "My task",
      "description": "Task description",
      "createTime": "2013-04-17T10:17:43.902+0000",
      "dueDate": "2013-04-17T10:17:43.902+0000",
      "priority": 50,
      "claimTime": "2018-04-17T10:17:43.902+0000",
      "taskDefinitionKey": "theTask",
      "scopeDefinitionId": "123",
      "scopeId": "123",
      "subScopeId": "123",
      "scopeType": "cmmn",
      "propagatedStageInstanceId": "123",
      "tenantId": "null",
      "category": "ExampleCategory",
      "caseInstanceId": "5",
      "caseInstanceUrl": "http://localhost:8182/cmmn-runtime/case-instances/5",
      "caseDefinitionId": "oneTaskCase%3A1%3A4",
      "caseDefinitionUrl": "http://localhost:8182/cmmn-runtime/case-definitions/oneTaskCase%3A1%3A4",
      "parentTaskId": "null",
      "parentTaskUrl": "null",
      "executionId": "123",
      "processInstanceId": "123",
      "processDefinitionId": "123",
      "variables": [
        {
          "name": "myVariable",
          "type": "string",
          "valueUrl": "http://...."
        }
      ]
    }
  ]
}

Changes

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