Job Definition

Get Job Definition Count (POST)

Queries for the number of job definitions that fulfill given parameters. This method takes the same message body as the Get Job Definitions (POST) method and therefore it is slightly more powerful than the Get Job Definition Count method.

post/job-definition/count

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/job-definition/count
  • Auth: HTTP basic

Request body

jobDefinitionIdstring nullable

Filter by job definition id.

activityIdInstring[] nullable

Only include job definitions which belong to one of the passed activity ids.

processDefinitionIdstring nullable

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

processDefinitionKeystring nullable

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

jobTypestring nullable

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

jobConfigurationstring nullable

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

activeboolean nullable

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

suspendedboolean nullable

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

withOverridingJobPriorityboolean nullable

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.

tenantIdInstring[] nullable

Only include job definitions which belong to one of the passed tenant ids.

withoutTenantIdboolean nullable

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

includeJobDefinitionsWithoutTenantIdboolean nullable

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.

countinteger

The number of matching instances.

Changes

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