Skip to main content
POST
/
external-task
/
count
Get List Count (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/external-task/count \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topicName": "aTopicName",
  "withRetriesLeft": true
}
'
{
  "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.

Body

application/json

A JSON object with the following properties:

​
externalTaskId
string | null

Filter by an external task's id.

​
externalTaskIdIn
string[] | null

Filter by the comma-separated list of external task ids.

​
topicName
string | null

Filter by an external task topic.

​
workerId
string | null

Filter by the id of the worker that the task was most recently locked by.

​
locked
boolean | null

Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be true, as false matches any external task.

​
notLocked
boolean | null

Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be true, as false matches any external task.

​
withRetriesLeft
boolean | null

Only include external tasks that have a positive (> 0) number of retries (or null). Value may only be true, as false matches any external task.

​
noRetriesLeft
boolean | null

Only include external tasks that have 0 retries. Value may only be true, as false matches any external task.

​
lockExpirationAfter
string<date-time> | null

Restrict to external tasks that have a lock that expires after a 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.000+0200.

​
lockExpirationBefore
string<date-time> | null

Restrict to external tasks that have a lock that expires before a 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.000+0200.

​
activityId
string | null

Filter by the id of the activity that an external task is created for.

​
activityIdIn
string[] | null

Filter by the comma-separated list of ids of the activities that an external task is created for.

​
executionId
string | null

Filter by the id of the execution that an external task belongs to.

​
processInstanceId
string | null

Filter by the id of the process instance that an external task belongs to.

​
processInstanceIdIn
string[] | null

Filter by a comma-separated list of process instance ids that an external task may belong to.

​
processDefinitionId
string | null

Filter by the id of the process definition that an external task belongs to.

​
tenantIdIn
string[] | null

Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.

​
active
boolean | null

Only include active tasks. Value may only be true, as false matches any external task.

​
suspended
boolean | null

Only include suspended tasks. Value may only be true, as false matches any external task.

​
priorityHigherThanOrEquals
integer<int64> | null

Only include jobs with a priority higher than or equal to the given value. Value must be a valid long value.

​
priorityLowerThanOrEquals
integer<int64> | null

Only include jobs with a priority lower than or equal to the given value. Value must be a valid long value.

​
processDefinitionKey
string | null

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

​
processDefinitionKeyIn
string[] | null

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 | null

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

​
processDefinitionNameLike
string | null

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

​
variableNamesIgnoreCase
boolean | null
default:false

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

​
variableValuesIgnoreCase
boolean | null
default:false

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

​
processVariables
object[] | null

A JSON array to only include tasks that belong to a process instance with variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean.

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.

​
sorting
object[] | null

A JSON array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. The ordering objects have the following properties:

**Note:** The `sorting` properties will not be applied to the External Task count query.

Response

Request successful.

​
count
integer<int64>

The number of matching instances.