Cancel Workflow
Base URL:
EU 🇪🇺 : https://api.fra.e1.enboarder.com
US 🇺🇸 : https://api.ore.e1.enboarder.com
CA 🇨🇦 : https://api.can.e1.enboarder.com
API Endpoint
Using API Key - {{baseURL}}/restapi/v1/cancelwf
Using OAuth - {{baseURL}}/restapi/v2/cancelwf
Request Method: POST
This API Cancels Enboarder workflow. If Workflow is not available or is already Complete or Cancelled API return error response.
Sample Request:
{
"externalid": "ENB-494398793433",
"comments": "Employee has voluntarily terminated”,
“mode”: “ALL”
}
Response
On Success, the below response will be returned:
Resposne Body:
{ "message": "Workflow updated successfully for externalid [ENT-68736879-0001]", }
Where the referenceid is the externalid passed in the request body or uniqueid generated by system launched from.
On Error, the below response will be returned:
Resposne Body:
{ "message": "Error: externalid [ENT-68736879-0005] not found" }
Message will contain error message.
Attribute Names & Descriptions:
externalid
Identifier that uniquely identifies an instance of running Workflow in Enboarder
Required
comments
any additional comments for cancellation of workflow
Optional
mode
Determines workflow to cancel. Multiple workflows can be launched with same externalid but with different criteria, so while cancelling specific workflow can be cancelled by providing specific criteria and mode as SELECTED. Possible values are:
ALL (Default): All workflows for the externalid will be cancelled. All Workflows must be either in Pending, InProcess, Cancel or Deleted state.
SELECTED: Specific workflow with matching criteria will be cancelled.
CANCEL_ALL: All workflows for the external which are in PENDING or INPROGRESS state will be canceled, rest will be ignored.
Optional
customfields
List of all custom fields for the workflow. They are name , value pairs. name should match the name of custom field defined in Enboarder. Brand, location and optional categories can also be provided in custom fields with name as ‘brand’, ‘location’ and category name in Enboarder respectively.
Optional