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

Retrieves the number of tasks that fulfill a provided filter. Corresponds to the size of the result set when using the Get Tasks method.

Security Consideration: There are several query 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.

get/task/count

Request

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

Query parameters

taskIdstring

Restrict to task with the given id.

taskIdInstring

Restrict to tasks with any of the given ids.

processInstanceIdstring

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

processInstanceIdInstring

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

processInstanceBusinessKeystring

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

processInstanceBusinessKeyExpressionstring

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

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

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

processInstanceBusinessKeyLikeExpressionstring

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

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

processDefinitionKeystring

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

processDefinitionKeyInstring

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

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

processDefinitionNameLikestring

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

executionIdstring

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

caseInstanceIdstring

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

caseInstanceBusinessKeystring

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

caseInstanceBusinessKeyLikestring

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

caseDefinitionIdstring

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

caseDefinitionKeystring

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

caseDefinitionNamestring

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

caseDefinitionNameLikestring

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

caseExecutionIdstring

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

activityInstanceIdInstring

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

tenantIdInstring

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

withoutTenantIdboolean

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

assigneestring

Restrict to tasks that the given user is assigned to.

assigneeExpressionstring

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

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

assigneeLikeExpressionstring

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

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

assigneeNotInstring

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

ownerstring

Restrict to tasks that the given user owns.

ownerExpressionstring

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

candidateGroupstring

Only include tasks that are offered to the given group.

candidateGroupLikestring

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

candidateGroupExpressionstring

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

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

candidateUserExpressionstring

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

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

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

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

If set to true, restricts the query to all tasks that are assigned.

unassignedboolean

If set to true, restricts the query to all tasks that are unassigned.

taskDefinitionKeystring

Restrict to tasks that have the given key.

taskDefinitionKeyInstring

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

taskDefinitionKeyNotInstring

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

taskDefinitionKeyLikestring

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

namestring

Restrict to tasks that have the given name.

nameNotEqualstring

Restrict to tasks that do not have the given name.

nameLikestring

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

nameNotLikestring

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

descriptionstring

Restrict to tasks that have the given description.

descriptionLikestring

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

priorityinteger

Restrict to tasks that have the given priority.

maxPriorityinteger

Restrict to tasks that have a lower or equal priority.

minPriorityinteger

Restrict to tasks that have a higher or equal priority.

dueDatestring

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

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

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

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

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

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

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

followUpDatestring

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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'

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

candidateGroupsstring

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

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

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

withoutCandidateGroupsboolean

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

withCandidateUsersboolean

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

withoutCandidateUsersboolean

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

activeboolean

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

suspendedboolean

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

taskVariablesstring

Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters.

processVariablesstring

Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like; notLike. key and value may not contain underscore or comma characters.

caseInstanceVariablesstring

Only include tasks that belong to case instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

variableNamesIgnoreCaseboolean

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

variableValuesIgnoreCaseboolean

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

parentTaskIdstring

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

withCommentAttachmentInfoboolean

Check if task has attachments and/or comments. Value may only be true, as false is the default behavior. Adding the filter will do additional attachment and comments queries to the database, it might slow down the query in case of tables having high volume of data. This param is not considered for count queries

withTaskVariablesInReturnboolean

Indicates if all the variables visible from task should be retrieved. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. Value may only be true, as false is the default behavior.

withTaskLocalVariablesInReturnboolean

Indicates if all the local variables visible from task should be retrieved. Value may only be true, as false is the default behavior.

Response

Request successful.

countinteger

The number of matching instances.

Changes

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