Skip to main content
GET
/
job-definition
/
count
Get Job Definition Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/job-definition/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

jobDefinitionId
string

Filter by job definition id.

activityIdIn
string

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

processDefinitionId
string

Only include job definitions which exist for the given process definition id.

processDefinitionKey
string

Only include job definitions which exist for the given process definition key.

jobType
string

Only include job definitions which exist for the given job type. See the User Guide for more information about job types.

jobConfiguration
string

Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration.

active
boolean

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

suspended
boolean

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

withOverridingJobPriority
boolean

Only include job definitions that have an overriding job priority defined. The only effective value is true. If set to false, this filter is not applied.

tenantIdIn
string

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

withoutTenantId
boolean

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

includeJobDefinitionsWithoutTenantId
boolean

Include job definitions 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.