Activate/Suspend Jobs By Process Instance Id

Activates or suspends jobs with the given process instance id.

Method

PUT /job/suspended

Parameters

Request Body

A JSON object with the following properties:

Name Description
processInstanceId The process instance id of the jobs to activate or suspend.
suspended A Boolean value which indicates whether to activate or suspend all jobs with the given process instance id. When the value is set to true, all jobs with the given process instance id will be suspended and when the value is set to false, all jobs with the given process instance id will be activated.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Returned if some of the request parameters are invalid, for example if the processInstanceId parameter is null. See the Introduction for the error response format.

Example

Request

PUT /job/suspended

{
  "processInstanceId" : "aProcessInstanceId",
  "suspended" : true
}

Response

Status 204. No content.

On this Page: