cancelWorkflow
This method cancels a workflow. To use it, it is necessary to follow the standard documented below:
Java class | |
---|---|
Request | web\wwwroot\ws\java\workflow\CancelWorkflowRequestType.java |
Return | web\wwwroot\ws\java\workflow\CancelWorkflowResponseType.java |
Request:
ID # | Required | Description |
---|---|---|
WorkflowID | X | Workflow ID # |
Explanation | X | Explanation |
UserID | User 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 |
---|---|
Status | Method execution status. Its value may be: SUCCESS: Method executed successfully FAILURE: An error occurred during the method execution |
Code | Method return code |
Detail | Method return detail |