Hold Task

The Hold Task API allows you to hold a task which is in ready status. With this api, external systemd can change one or more task statuses to ‘Held’ from ‘Ready’. You can exclude tasks that are not currently required to be executed by the assigned user without accessing the web UI. Users who have the Task/ Can hold/release task permission enabled should be able to put a task on ‘Held’ status.

The following are some ways for calling the Hold task API:

Using the Task ID:

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

Note: No additional parameters data in the request body is required.

Using the Task Number:

POST.../entity/task/hold/

Note: The API body should include facility id/code, company id/code and task number.

Using the Bulk Task Hold:

POST.../entity/task/bulk_hold/

Note: The API body should task number list. Users can also provide the commit frequency as an option. 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 will commit per object.

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

Using the Bulk Hold Task

POST.../entity/task/bulk_hold/

		{ 
	   "parameters": { 
	         "id__in": [01, 02, 03] 
	    }, 
	   "options": { 
	        "commit_frequency": "0",
	    } 
	}