Sign in
Process Definition

Activate/Suspend By Id

Activates or suspends a given process definition by id.

put/process-definition/{id}/suspended

Request

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

Path parameters

idstring required

The id of the process definition to activate or suspend.

Request body

suspendedboolean nullable

A Boolean value which indicates whether to activate or suspend all process definitions with the given key. When the value is set to true, all process definitions with the given key will be suspended and when the value is set to false, all process definitions with the given key will be activated.

processDefinitionIdstring nullable

The id of the process definitions to activate or suspend.

processDefinitionKeystring nullable

The key of the process definitions to activate or suspend.

includeProcessInstancesboolean nullable

A Boolean value which indicates whether to activate or suspend also all process instances of the process definitions with the given key. When the value is set to true, all process instances of the process definitions with the given key will be activated or suspended and when the value is set to false, the suspension state of all process instances of the process definitions with the given key will not be updated.

executionDatestring date-time nullable

The date on which all process definitions with the given key will be activated or suspended. If null, the suspension state of all process definitions with the given key 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.

Response

Request successful.

Changes

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