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

Task

Get List Count (POST)

Retrieves the number of tasks that fulfill the given filter. Corresponds to the size of the result set of the Get Tasks (POST) method and takes the same parameters.

Security Consideration: There are several parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on security considerations for custom code in the user guide for details.

post/task/count

Request

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

Request body

taskIdstring nullable

Restrict to task with the given id.

taskIdInstring[] nullable

Restrict to tasks with any of the given ids.

processInstanceIdstring nullable

Restrict to tasks that belong to process instances with the given id.

processInstanceIdInstring[] nullable

Restrict to tasks that belong to process instances with the given ids.

processInstanceBusinessKeystring nullable

Restrict to tasks that belong to process instances with the given business key.

processInstanceBusinessKeyExpressionstring nullable

Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the user guide for more information on available functions.

processInstanceBusinessKeyInstring[] nullable

Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list.

processInstanceBusinessKeyLikestring nullable

Restrict to tasks that have a process instance business key that has the parameter value as a substring.

processInstanceBusinessKeyLikeExpressionstring nullable

Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the user guide for more information on available functions.

processDefinitionIdstring nullable

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

processDefinitionKeystring nullable

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

processDefinitionKeyInstring[] nullable

Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list.

processDefinitionNamestring nullable

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

processDefinitionNameLikestring nullable

Restrict to tasks that have a process definition name that has the parameter value as a substring.

executionIdstring nullable

Restrict to tasks that belong to an execution with the given id.

caseInstanceIdstring nullable

Restrict to tasks that belong to case instances with the given id.

caseInstanceBusinessKeystring nullable

Restrict to tasks that belong to case instances with the given business key.

caseInstanceBusinessKeyLikestring nullable

Restrict to tasks that have a case instance business key that has the parameter value as a substring.

caseDefinitionIdstring nullable

Restrict to tasks that belong to a case definition with the given 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.

caseDefinitionNameLikestring nullable

Restrict to tasks that have a case definition name that has the parameter value as a substring.

caseExecutionIdstring nullable

Restrict to tasks that belong to a case execution with the given id.

activityInstanceIdInstring[] nullable

Only include tasks which belong to one of the passed and comma-separated activity instance ids.

tenantIdInstring[] nullable

Only include tasks which belong to one of the passed and comma-separated tenant ids.

withoutTenantIdboolean nullable

Only include tasks which belong to no tenant. Value may only be true, as false is the default behavior.

assigneestring nullable

Restrict to tasks that the given user is assigned to.

assigneeExpressionstring nullable

Restrict to tasks that the user described by the given expression is assigned to. See the user guide for more information on available functions.

assigneeLikestring nullable

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

assigneeLikeExpressionstring nullable

Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the user guide for more information on available functions.

assigneeInstring[] nullable

Only include tasks which are assigned to one of the passed and comma-separated user ids.

assigneeNotInstring[] nullable

Only include tasks which are not assigned to one of the passed and comma-separated user ids.

ownerstring nullable

Restrict to tasks that the given user owns.

ownerExpressionstring nullable

Restrict to tasks that the user described by the given expression owns. See the user guide for more information on available functions.

candidateGroupstring nullable

Only include tasks that are offered to the given group.

candidateGroupLikestring nullable

Only include tasks that are offered to groups that have the parameter value as a substring.

candidateGroupExpressionstring nullable

Only include tasks that are offered to the group described by the given expression. See the user guide for more information on available functions.

candidateUserstring nullable

Only include tasks that are offered to the given user or to one of his groups.

candidateUserExpressionstring nullable

Only include tasks that are offered to the user described by the given expression. See the user guide for more information on available functions.

includeAssignedTasksboolean nullable

Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s).

involvedUserstring nullable

Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee).

involvedUserExpressionstring nullable

Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the user guide for more information on available functions.

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.

taskDefinitionKeystring nullable

Restrict to tasks that have the given key.

taskDefinitionKeyInstring[] nullable

Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list.

taskDefinitionKeyNotInstring[] nullable

Exclude instances by a list of task definition keys. The keys need to be in a comma-separated list.

taskDefinitionKeyLikestring nullable

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

namestring nullable

Restrict to tasks that have the given name.

nameNotEqualstring nullable

Restrict to tasks that do not have the given name.

nameLikestring nullable

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

nameNotLikestring nullable

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

descriptionstring nullable

Restrict to tasks that have the given description.

descriptionLikestring nullable

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

priorityinteger nullable

Restrict to tasks that have the given priority.

maxPriorityinteger nullable

Restrict to tasks that have a lower or equal priority.

minPriorityinteger nullable

Restrict to tasks that have a higher or equal priority.

dueDatestring 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.546+0200.

dueDateExpressionstring nullable

Restrict to tasks that are due on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

dueAfterstring 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.435+0200.

dueAfterExpressionstring nullable

Restrict to tasks that are due after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

dueBeforestring 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.243+0200.

dueBeforeExpressionstring nullable

Restrict to tasks that are due before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

withoutDueDateboolean nullable

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

followUpDatestring 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.342+0200.

followUpDateExpressionstring nullable

Restrict to tasks that have a followUp date on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

followUpAfterstring 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.542+0200.

followUpAfterExpressionstring nullable

Restrict to tasks that have a followUp date after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

followUpBeforestring 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.234+0200.

followUpBeforeExpressionstring nullable

Restrict to tasks that have a followUp date before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

followUpBeforeOrNotExistentstring date-time nullable

Restrict to tasks that have no followUp date or 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.432+0200. The typical use case is to query all active tasks for a user for a given date.

followUpBeforeOrNotExistentExpressionstring nullable

Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

createdOnstring date-time nullable

Restrict to tasks that were created 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.324+0200.

createdOnExpressionstring nullable

Restrict to tasks that were created on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

createdAfterstring date-time nullable

Restrict to tasks that were created 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.342+0200.

createdAfterExpressionstring nullable

Restrict to tasks that were created after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

createdBeforestring date-time nullable

Restrict to tasks that were created 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.332+0200.

createdBeforeExpressionstring nullable

Restrict to tasks that were created before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

updatedAfterstring date-time nullable

Restrict to tasks that were updated after the given date. Every action that fires a task update event is considered as updating the task. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.332+0200.

updatedAfterExpressionstring nullable

Restrict to tasks that were updated after the date described by the given expression. Every action that fires a task update event is considered as updating the task. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

delegationState'PENDING' | 'RESOLVED' nullable

Restrict to tasks that are in the given delegation state. Valid values are PENDING and RESOLVED.

candidateGroupsstring[] nullable

Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example developers,support,sales.

candidateGroupsExpressionstring nullable

Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the user guide for more information on available functions. The expression must evaluate to java.util.List of Strings.

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.

withCandidateUsersboolean nullable

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

withoutCandidateUsersboolean nullable

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

activeboolean nullable

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

suspendedboolean nullable

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

variableNamesIgnoreCaseboolean nullable

Match all variable names in this query case-insensitively. If set variableName and variablename are treated as equal.

variableValuesIgnoreCaseboolean nullable

Match all variable values in this query case-insensitively. If set variableValue and variablevalue are treated as equal.

parentTaskIdstring nullable

Restrict query to all tasks that are sub tasks of the given task. Takes a task id.

Response

Request successful.

countinteger

The number of matching instances.

Changes

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