REST API - ignoreProcessInstances

The table summarizes the REST API - ignoreProcessInstances.

Request

Format
PUT <baseurl>/process/ignore/instances/<module>/<process>/<version>
Path parameters
  • module: Name of the module to which the process template belongs.
  • process: Name of the process template whose halted process instances are to be ignored.
  • version: OSGi-style version number of the process template. (This version number is the same as that of the module.)

    You can determine the process instances that are halted using the queryHaltedProcessInstances method. Using the halted process instance process name, use listProcessTemplates to determine the parameters above.

Response

JSON If successful, returns 204 No Content in the response header. The response body contains an integer value indicating the number of process instances that were ignored.
XML If successful, returns 204 No Content in the response header. The response body contains an integer value indicating the number of process instances that were ignored.

Example

Request
PUT <baseurl>/process/ignore/instances/%2FAcme-CommonFields%2FProcess%20Packages%2FCommonFields.xpdl/ErrorTestsProcess/1.0.0.201210231047
Response
3