Skip to main content
Version: 2.2.2

cancelWorkflow

This method cancels a workflow. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb\wwwroot\ws\java\workflow\CancelWorkflowRequestType.java
Returnweb\wwwroot\ws\java\workflow\CancelWorkflowResponseType.java

Request:

ID #RequiredDescription
WorkflowIDXWorkflow ID #
ExplanationXExplanation
UserIDUser ID. When given, it will remain in the instance history that it was cancelled by this user. Otherwise, the authentication user will be recorded.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:workflow">
<soapenv:Header/>
<soapenv:Body>
<urn:cancelWorkflow>
<!--You may enter the following 3 items in any order-->
<urn:WorkflowID>?</urn:WorkflowID>
<urn:Explanation>?</urn:Explanation>
<!--Optional:-->
<urn:UserID>?</urn:UserID>
</urn:cancelWorkflow>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
StatusMethod execution status. Its value may be:
SUCCESS: Method executed successfully
FAILURE: An error occurred during the method execution
CodeMethod return code
DetailMethod return detail