FLflowable
Tasks

List of tasks

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-runtime/tasks

Request

Query parameters

taskIdstring

Only return tasks with the given id.

namestring

Only return tasks with the given name.

nameLikestring

Only return tasks with a name like the given name.

nameLikeIgnoreCasestring

Only return tasks with a name like the given name ignoring case.

descriptionstring

Only return tasks with the given description.

prioritystring

Only return tasks with the given priority.

minimumPrioritystring

Only return tasks with a priority greater than the given value.

maximumPrioritystring

Only return tasks with a priority lower than the given value.

assigneestring

Only return tasks assigned to the given user.

assigneeLikestring

Only return tasks assigned with an assignee like the given value.

ownerstring

Only return tasks owned by the given user.

ownerLikestring

Only return tasks assigned with an owner like the given value.

unassignedstring

Only return tasks that are not assigned to anyone. If false is passed, the value is ignored.

delegationStatestring

Only return tasks that have the given delegation state. Possible values are pending and resolved.

candidateUserstring

Only return tasks that can be claimed by the given user. This includes both tasks where the user is an explicit candidate for and task that are claimable by a group that the user is a member of.

candidateGroupstring

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

candidateGroupsstring

Only return tasks that can be claimed by a user in the given groups. Values split by comma.

involvedUserstring

Only return tasks in which the given user is involved.

taskDefinitionKeystring

Only return tasks with the given task definition id.

taskDefinitionKeyLikestring

Only return tasks with a given task definition id like the given value.

caseInstanceIdstring

Only return tasks which are part of the case instance with the given id.

caseInstanceIdWithChildrenstring

Only return tasks which are part of the case instance and its children with the given id.

caseDefinitionIdstring

Only return tasks which are part of a case instance which has a case definition with the given id.

caseDefinitionKeystring

Only return tasks which are part of a case instance which has a case definition with the given key.

caseDefinitionKeyLikestring

Only return tasks which are part of a case instance which has a case definition with the given key like the passed parameter.

caseDefinitionKeyLikeIgnoreCasestring

Only return tasks which are part of a case instance which has a case definition with the given key like the passed parameter.

planItemInstanceIdstring

Only return tasks which are associated with the a plan item instance with the given id

propagatedStageInstanceIdstring

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

scopeIdstring

Only return tasks which are part of the scope (e.g. case instance) with the given id.

scopeIdsstring

Only return tasks which are part of the scope (e.g. case instance) with the given ids.

withoutScopeIdboolean

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

subScopeIdstring

Only return tasks which are part of the sub scope (e.g. plan item instance) with the given id.

scopeTypestring

Only return tasks which are part of the scope type (e.g. bpmn, cmmn, etc).

createdOnstring date-time

Only return tasks which are created on the given date.

createdBeforestring date-time

Only return tasks which are created before the given date.

createdAfterstring date-time

Only return tasks which are created after the given date.

dueOnstring date-time

Only return tasks which are due on the given date.

dueBeforestring date-time

Only return tasks which are due before the given date.

dueAfterstring date-time

Only return tasks which are due after the given date.

withoutDueDateboolean

Only return tasks which do not have a due date. The property is ignored if the value is false.

excludeSubTasksboolean

Only return tasks that are not a subtask of another task.

activeboolean

If true, only return tasks that are not suspended (either part of a process that is not suspended or not part of a process at all). If false, only tasks that are part of suspended process instances are returned.

includeTaskLocalVariablesboolean

Indication to include task local variables in the result.

includeProcessVariablesboolean

Indication to include process variables in the result.

tenantIdstring

Only return tasks with the given tenantId.

tenantIdLikestring

Only return tasks with a tenantId like the given value.

withoutTenantIdboolean

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

withoutProcessInstanceIdboolean

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

candidateOrAssignedstring

Select tasks that has been claimed or assigned to user or waiting to claim by user (candidate user or groups).

categorystring

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

categoryInstring

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

categoryNotInstring

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

withoutCategorystring

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

rootScopeIdstring

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

parentScopeIdstring

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

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.