POST Update task
Introduction
Updates an existing yard task's details including assigned users, locations, priorities, and associated receipts or loads. Allows modification of task assignments, descriptions, notes, and entry ticket information. This API is used when task requirements change, reassigning tasks to different users or locations, or updating task priorities based on operational needs.
POST /public/task/{taskId}/update
Body Request Parameters
{
"assignUserName": "string",
"assignLocationId": "string",
"customerId": "string",
"receiptIds": [
"string"
],
"loadIds": [
"string"
],
"assigneeUserId": "string",
"description": "string",
"entryId": "string",
"priority": "string",
"note": "string"
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| taskId | path | string | Yes | none |
| X-Tenant-ID | header | string | No | none |
| X-Yard-ID | header | string | No | none |
| Item-Time-Zone | header | string | No | none |
| Authorization | header | string | No | none |
| Item-Bam-Client | header | string | No | none |
| x-facility-id | header | string | No | none |
| body | body | object | No | none |
| » assignUserName | body | string | No | Assigned user |
| » assignLocationId | body | string | No | Assigned location |
| » customerId | body | string | Yes | Customer ID |
| » receiptIds | body | [string] | No | none |
| » loadIds | body | [string] | No | none |
| » assigneeUserId | body | string | No | none |
| » description | body | string | No | none |
| » entryId | body | string | Yes | none |
| » priority | body | string | No | Task priority level (from WMS) |
| » note | body | string | No | Task notes or remarks (from WMS) |
Detailed Description
» assignLocationId: Assigned location When updating, only the assigned location is modified; the planned location (plannedLocationId) remains unchanged.
Response Example
200 Response
{
"id": 0,
"taskId": "",
"taskType": "",
"timeStatus": "",
"startTime": "",
"lastPauseTime": "",
"endTime": "",
"totalRunTime": 0,
"totalPausedTime": 0,
"createdTime": "",
"updatedTime": "",
"createdBy": "",
"updatedBy": "",
"assignUserName": "",
"plannedLocationId": "",
"assignLocationId": "",
"assignLocationName": "",
"customerId": "",
"customerName": "",
"entryId": "",
"loadIds": [
""
],
"receiptIds": [
""
],
"taskStatus": "",
"assigneeUserId": "",
"description": "",
"priority": "",
"note": "",
"lastStepAssignedUserIds": [
""
],
"planedLastStepAssignedUserIds": [
""
],
"lastStepAssignedUserNames": [
""
],
"planedLastStepAssignedUserNames": [
""
],
"lastStepId": "",
"planedAssignAllSteps": false
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | GeneralTaskView |