Sign in
Process Instance

Activate/Suspend In Group

Activates or suspends process instances by providing certain criteria:

Activate/Suspend Process Instance By Process Definition Id

  • suspend
  • processDefinitionId

Activate/Suspend Process Instance By Process Definition Key

  • suspend
  • processDefinitionKey
  • processDefinitionTenantId
  • processDefinitionWithoutTenantId

Activate/Suspend Process Instance In Group

  • suspend
  • processInstanceIds
  • processInstanceQuery
  • historicProcessInstanceQuery
put/process-instance/suspended

Request

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

Request body

processDefinitionIdstring nullable

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

Note: This parameter can be used only with combination of suspended.

processDefinitionKeystring nullable

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

Note: This parameter can be used only with combination of suspended, processDefinitionTenantId, and processDefinitionWithoutTenantId.

processDefinitionTenantIdstring nullable

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

Note: This parameter can be used only with combination of suspended, processDefinitionKey, and processDefinitionWithoutTenantId.

processDefinitionWithoutTenantIdboolean nullable

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

Note: This parameter can be used only with combination of suspended, processDefinitionKey, and processDefinitionTenantId.

processInstanceIdsstring[] nullable

A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation.

Note: This parameter can be used only with combination of suspended, processInstanceQuery, and historicProcessInstanceQuery.

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.

Changes

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