REST API - cancelProcessInstances

The table summarizes the REST API - cancelProcessInstances.

Request

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

    These parameters can be obtained from listProcessInstances , queryProcessInstances , and queryProcessInstancesAlt .

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 cancelled.
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 cancelled.

Example

Request 
DELETE <baseurl>/process/cancel/HelpDesk%2FProcess%20Packages%2FHelpDesk.xpdl/HelpDeskProcess/1.0.0.201210231049
Response 
5