Assign Task
The new Assign Task API allows you to assign a task to another user. For example, a task may require equipment handling like a forklift. The warehouse manager can assign the task to a specific user who can handle a forklift with this API without accessing the Web UI. However, you can assign a task with this API only if the Task/ Assign User Permission is enabled.
The following are some ways for calling the Assign Task API:
Using the Task ID:
POST.../entity/task/{id}/assign_user/
Options
Category | Name | Type | Required | Description |
---|---|---|---|---|
Options | assigned_user | string | X | user who is being assigned to the task |
Note: You need to provide the ‘assigned_user’ in the request body as this is a post
operation of tasks to assign users.
Using the Task Number:
POST .../entity/task/assign_user/
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 updated |
Options
Category | Name | Type | Required | Description |
---|---|---|---|---|
Options | assigned_user | string | X | user who is being assigned to the task |
Note: The API body should include facility id/code, company id/code and task number. You
are also required to provide the ‘assigned_user’ in the request body as this is a
post operation of tasks to assign users.
Using the Bulk Task Release:
POST.../entity/task/bulk_assign_user/
POST.../entity/task/bulk_assign_user/
{
"parameters": {
"id__in": [01, 02, 03]
},
"options": {
"assigned_user": "KHALL01",
"commit_frequency": "0",
}
}
Note: The API body should have the task number list. You are also required to provide
the ‘assigned_user’ in the request body. You can send the commit frequency as an
option as well. 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.
- If the status of one or more of the selected tasks goes to Processing Started, completed, In Drop between Zones, Cancelled the return error and will not assign any user to the task.
- If task equipment and user equipment eligibility check fails for the assigned user, the API will return an error.