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

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

jobId
string

Filter by job id.

jobIds
string

Filter by a comma-separated list of job ids.

jobDefinitionId
string

Only select jobs which exist for the given job definition.

processInstanceId
string

Only select jobs which exist for the given process instance.

processInstanceIds
string

Only select jobs which exist for the given comma-separated list of process instance ids.

executionId
string

Only select jobs which exist for the given execution.

processDefinitionId
string

Filter by the id of the process definition the jobs run on.

processDefinitionKey
string

Filter by the key of the process definition the jobs run on.

activityId
string

Only select jobs which exist for an activity with the given id.

withRetriesLeft
boolean

Only select jobs which have retries left. Value may only be true, as false is the default behavior.

executable
boolean

Only select jobs which are executable, i.e., retries > 0 and due date is null or due date is in the past. Value may only be true, as false is the default behavior.

timers
boolean

Only select jobs that are timers. Cannot be used together with messages. Value may only be true, as false is the default behavior.

messages
boolean

Only select jobs that are messages. Cannot be used together with timers. Value may only be true, as false is the default behavior.

dueDates
string

Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

Valid operator values are: gt - greater than; lt - lower than. value may not contain underscore or comma characters.

createTimes
string

Only select jobs created before or after the given date.

Create time expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

Valid operator values are: gt - greater than; lt - lower than. value may not contain underscore or comma characters.

withException
boolean

Only select jobs that failed due to an exception. Value may only be true, as false is the default behavior.

exceptionMessage
string

Only select jobs that failed due to an exception with the given message.

failedActivityId
string

Only select jobs that failed due to an exception at an activity with the given id.

noRetriesLeft
boolean

Only select jobs which have no retries left. Value may only be true, as false is the default behavior.

active
boolean

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

suspended
boolean

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

priorityLowerThanOrEquals
integer

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

priorityHigherThanOrEquals
integer

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

tenantIdIn
string

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

withoutTenantId
boolean

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

includeJobsWithoutTenantId
boolean

Include jobs which belong to no tenant. Can be used in combination with tenantIdIn. Value may only be true, as false is the default behavior.

Response

Request successful.

count
integer

The number of matching instances.