Sign in
Job

Activate/Suspend Jobs

Activates or suspends jobs matching the given criterion. This can only be on of:

  • jobDefinitionId
  • processDefinitionId
  • processInstanceId
  • processDefinitionKey
put/job/suspended

Request

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

Request body

jobDefinitionIdstring nullable

The job definition id of the jobs to activate or suspend.

processDefinitionIdstring nullable

The process definition id of the jobs to activate or suspend.

processInstanceIdstring nullable

The process instance id of the jobs to activate or suspend.

processDefinitionKeystring nullable

The process definition key of the jobs to activate or suspend.

processDefinitionTenantIdstring nullable

Only activate or suspend jobs of a process definition which belongs to a tenant with the given id. Works only when selecting with processDefinitionKey.

processDefinitionWithoutTenantIdboolean nullable

Only activate or suspend jobs of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. Works only when selecting with processDefinitionKey.

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.