Workflow Instances
Cancel workflow instance.
Cancels the workflow instance with the specified ID with a reason. Canceling the workflow instance also cancels the workflow sub-processes.
post/workflowInstances/{workflowInstanceId}/canceled
Request
- Base URL/rest/2.0 (relative, and the document’s source URL is not known)
- Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2Client credentialsToken URL/rest/oauth/v2/tokenScopessys.admin
- or OAuth 2Client credentialsToken URL/rest/oauth/v2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
workflowInstanceIdstring uuid required
The identifier of the workflow instance to be cancelled.
Request body
string required
Response
The workflow instance has been successfully canceled.
Changes
No recorded changes to this operation across all 1 revision of this API.