Job Definition

Activate/Suspend Job Definitions

Activates or suspends job definitions with the given process definition id or process definition key.

put/job-definition/suspended

Request

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

Request body

processDefinitionIdstring nullable

The process definition id of the job definitions to activate or suspend.

processDefinitionKeystring nullable

The process definition key of the job definitions to activate or suspend.

processDefinitionTenantIdstring nullable

Only activate or suspend job definitions of a process definition which belongs to a tenant with the given id.

Note that this parameter will only be considered in combination with processDefinitionKey.

processDefinitionWithoutTenantIdboolean nullable

Only activate or suspend job definitions of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior.

Note that this parameter will only be considered in combination with processDefinitionKey.

includeJobsboolean nullable

A Boolean value which indicates whether to activate or suspend also all jobs of the referenced job definitions. When the value is set to true, all jobs of the provided job definitions will be activated or suspended and when the value is set to false, the suspension state of all jobs of the provided job definitions will not be updated.

executionDatestring nullable

The date on which the referenced job definitions will be activated or suspended. If null, the suspension state of the given job definitions is updated immediately. 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.

suspendedboolean nullable

A Boolean value which indicates whether to activate or suspend a given instance (e.g. process instance, job, job definition, or batch). When the value is set to true, the given instance will be suspended and when the value is set to false, the given instance will be activated.

Response

Request successful. This method returns no content.

Changes

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