Process Definition

Restart Process Instance

Restarts process instances that were canceled or terminated synchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the Restart Process Instance Async method.

For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the User Guide.

post/process-definition/{id}/restart

Request

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

Path parameters

idstring required

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

Request body

processInstanceIdsstring[] nullable

A list of process instance ids to restart.

skipCustomListenersboolean nullable

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

skipIoMappingsboolean nullable

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

initialVariablesboolean nullable

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

withoutBusinessKeyboolean nullable

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

Response

Request successful.

Changes

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