Sign in
Job Definition

Get Job Definition

Retrieves a job definition by id, according to the JobDefinition interface in the engine.

get/job-definition/{id}

Request

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

Path parameters

idstring required

The id of the job definition to be retrieved.

Response

Request successful.

idstring nullable

The id of the job definition.

processDefinitionIdstring nullable

The id of the process definition this job definition is associated with.

processDefinitionKeystring nullable

The key of the process definition this job definition is associated with.

activityIdstring nullable

The id of the activity this job definition is associated with.

jobTypestring nullable

The type of the job which is running for this job definition. See the User Guide for more information about job types.

jobConfigurationstring nullable

The configuration of a job definition provides details about the jobs which will be created. For example: for timer jobs it is the timer configuration.

overridingJobPriorityinteger nullable

The execution priority defined for jobs that are created based on this definition. May be null when the priority has not been overridden on the job definition level.

suspendedboolean nullable

Indicates whether this job definition is suspended or not.

tenantIdstring nullable

The id of the tenant this job definition is associated with.

deploymentIdstring nullable

The id of the deployment this job definition is related to. In a deployment-aware setup, this leads to all jobs of the same definition being executed on the same node.

Changes

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