REST interface for BPEL-related process resources - Process instance Resource - PUT (Terminate) Method

Sample method invocation

Parameters

Required Parameters

Name	Value Type	Description
action	string	Action to be performed for the specified process. Value Description forceTerminate Force the termination of a process.

Optional Parameters

Name	Value Type	Description
invokeCompensation	boolean	Terminate the process instance and also compensate any successfully completed work. Value Description true Compensate successfully completed work. false (default) Terminate without compensating work.

Request Content

None

Response Content

None

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The process does not exist.
409 Conflict	A conflict exists with the current state of the resource.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

6.2

Parent topic: Process instance Resource