REST API - cancelPageFlow

The table summarizes the REST API - cancelPageFlow.

Request

Format
DELETE <baseurl>/pageflow/cancel/<processid>
Path parameters processid: Unique identifier of a currently active pageflow process instance. This must be a value returned earlier in the pageResponse.context.processReference.id element of a startPageFlow or updatePageFlow response.

Response

JSON Returns a JSON representation of the contents of a cancelPageFlowResponse element.
XML Returns the contents of a cancelPageFlowResponse element (from the PageFlowService schema).

Example

Request
DELETE <baseurl>/pageflow/cancel/pvm:0a106
Response
<?xml version="1.0" encoding="UTF-8"?>
<status>SUCCESS</status>