Cancel Task

The Cancel Task API allows you to cancel a task which is in ready/held status through an API so that the tasks not yet picked up can be cancelled/or supervisor would want to cancel a task part of the wave.

API URL: Lookup by ID

POST.../entity/task/{id}/cancel/

No additional `parameters` data in the request body is required.

API URL: Lookup by Filters

POST.../entity/task/cancel/

Category	Name	Required	Type	Description
parameters	facility_id		Integer	Facility context by id
parameters	facility_id__code		string	Facility context by code
parameters	company_id		Integer	Company context by id
parameters	company_id__code		string	Company context by code
parameters	task_nbr	X	string	Task which needs to be on hold

• If the facility and/or company are provided, set login context accordingly.
• Only one of `facility_id` or `facility_id__code` may be provided.
• Only one of `company_id` or `company_id__code` may be provided.

Bulk Cancel URL

POST.../entity/task/bulk_cancel/

Request Body:

The transaction is meant for the task entity. So, the users are required to send the following parameters in the body.

POST.../entity/task/bulk_hold/
{ 
   "parameters": { 
         "id__in": [01, 02, 03] 
    }, 
   "options": { 
        "commit_frequency": "0",
    } 
}

The commit frequency is by default set to 0. If it is set to 0, the system should roll back on first error/ If the commit frequency is set to 1, the system should commit per object.