Skip to main content
GET
/
task
/
count
Get List Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/task/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 1
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

taskId
string

Restrict to task with the given id.

taskIdIn
string

Restrict to tasks with any of the given ids.

processInstanceId
string

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

processInstanceIdIn
string

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

processInstanceBusinessKey
string

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

processInstanceBusinessKeyExpression
string

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.

processInstanceBusinessKeyIn
string

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.

processInstanceBusinessKeyLike
string

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

processInstanceBusinessKeyLikeExpression
string

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.

processDefinitionId
string

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

processDefinitionKey
string

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

processDefinitionKeyIn
string

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.

processDefinitionName
string

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

processDefinitionNameLike
string

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

executionId
string

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

caseInstanceId
string

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

caseInstanceBusinessKey
string

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

caseInstanceBusinessKeyLike
string

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

caseDefinitionId
string

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

caseDefinitionKey
string

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

caseDefinitionName
string

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

caseDefinitionNameLike
string

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

caseExecutionId
string

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

activityInstanceIdIn
string

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

tenantIdIn
string

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

withoutTenantId
boolean
default:false

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

assignee
string

Restrict to tasks that the given user is assigned to.

assigneeExpression
string

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

assigneeLike
string

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

assigneeLikeExpression
string

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.

assigneeIn
string

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

assigneeNotIn
string

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

owner
string

Restrict to tasks that the given user owns.

ownerExpression
string

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

candidateGroup
string

Only include tasks that are offered to the given group.

candidateGroupLike
string

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

candidateGroupExpression
string

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

candidateUser
string

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

candidateUserExpression
string

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

includeAssignedTasks
boolean
default:false

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

involvedUser
string

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

involvedUserExpression
string

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.

assigned
boolean
default:false

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

unassigned
boolean
default:false

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

taskDefinitionKey
string

Restrict to tasks that have the given key.

taskDefinitionKeyIn
string

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

taskDefinitionKeyLike
string

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

name
string

Restrict to tasks that have the given name.

nameNotEqual
string

Restrict to tasks that do not have the given name.

nameLike
string

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

nameNotLike
string

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

description
string

Restrict to tasks that have the given description.

descriptionLike
string

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

priority
integer

Restrict to tasks that have the given priority.

maxPriority
integer

Restrict to tasks that have a lower or equal priority.

minPriority
integer

Restrict to tasks that have a higher or equal priority.

dueDate
string

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.

dueDateExpression
string

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.

dueAfter
string

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.

dueAfterExpression
string

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.

dueBefore
string

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.

dueBeforeExpression
string

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.

withoutDueDate
boolean
default:false

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

followUpDate
string

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.

followUpDateExpression
string

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.

followUpAfter
string

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.

followUpAfterExpression
string

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.

followUpBefore
string

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.

followUpBeforeExpression
string

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.

followUpBeforeOrNotExistent
string

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.

followUpBeforeOrNotExistentExpression
string

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.

createdOn
string

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.

createdOnExpression
string

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.

createdAfter
string

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.

createdAfterExpression
string

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.

createdBefore
string

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.

createdBeforeExpression
string

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.

updatedAfter
string

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.

updatedAfterExpression
string

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
enum<string>

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

Available options:
PENDING,
RESOLVED
candidateGroups
string

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.

candidateGroupsExpression
string

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.

withCandidateGroups
boolean
default:false

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

withoutCandidateGroups
boolean
default:false

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

withCandidateUsers
boolean
default:false

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

withoutCandidateUsers
boolean
default:false

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

active
boolean
default:false

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

suspended
boolean
default:false

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

taskVariables
string

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.

processVariables
string

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.

caseInstanceVariables
string

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.

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.

variableNamesIgnoreCase
boolean
default:false

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

variableValuesIgnoreCase
boolean
default:false

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

parentTaskId
string

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

withCommentAttachmentInfo
boolean
default:false

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

Response

Request successful.

count
integer

The number of matching instances.