Skip to main content
POST
/
process-definition
/
{id}
/
restart
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-definition/{id}/restart \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": [
    {
      "type": "startAfterActivity",
      "activityId": "aUserTask"
    }
  ],
  "processInstanceIds": [
    "aProcessInstance",
    "anotherProcessInstance"
  ],
  "initialVariables": true,
  "skipCustomListeners": true,
  "withoutBusinessKey": true
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process definition of the process instances to restart.

Body

application/json
​
processInstanceIds
string[] | null

A list of process instance ids to restart.

​
historicProcessInstanceQuery
object

A historic process instance query which defines a group of historic process instances

​
skipCustomListeners
boolean | null

Skip execution listener invocation for activities that are started as part of this request.

​
skipIoMappings
boolean | null

Skip execution of input/output variable mappings for activities that are started as part of this request.

​
initialVariables
boolean | null

Set the initial set of variables during restart. By default, the last set of variables is used.

​
withoutBusinessKey
boolean | null

Do not take over the business key of the historic process instance.

​
instructions
object[] | null

Optional. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.

Response

Request successful.