POST Create task
Introduction
Creates a new yard task for equipment operations such as receiving, loading, unloading, or moving equipment. Tasks can be assigned to specific users and locations, linked to receipts or loads, and associated with entry tickets. Supports various task types including RECEIVE, LOAD, UNLOAD, and MOVE operations. This API is commonly used when scheduling yard operations or when equipment arrives at the yard requiring specific handling.
POST /public/task/create
Body Request Parameters
{
"taskId": "string",
"taskType": "RECEIVE",
"assignUserName": "string",
"assignLocationId": "string",
"customerId": "string",
"receiptIds": [
"string"
],
"loadIds": [
"string"
],
"entryId": "string",
"assigneeUserId": "string",
"loadMode": "LIVE_LOAD",
"description": "string",
"priority": "string",
"note": "string",
"lastStepAssignedUserIds": [
"string"
],
"lastStepAssignedUserNames": [
"string"
],
"equipmentId": "string"
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| 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 |
| » taskId | body | string | No | Task ID (optional) |
| » taskType | body | string | Yes | Task type |
| » assignUserName | body | string | No | Assigned user |
| » assignLocationId | body | string | No | Assigned location |
| » customerId | body | string | No | Customer ID |
| » receiptIds | body | [string] | No | none |
| » loadIds | body | [string] | No | none |
| » entryId | body | string | No | none |
| » assigneeUserId | body | string | No | none |
| » loadMode | body | string | No | none |
| » description | body | string | No | Task description |
| » priority | body | string | No | Task priority level |
| » note | body | string | No | Task notes/remarks |
| » lastStepAssignedUserIds | body | [string] | No | User IDs assigned to last step |
| » lastStepAssignedUserNames | body | [string] | No | User names assigned to last step |
| » equipmentId | body | string | No | Equipment ID |
Detailed Description
» taskId: Task ID (optional) If specified, the provided ID will be used; if not specified, one will be auto-generated.
» assignLocationId: Assigned location During internal processing, this value is assigned to both plannedLocationId (planned location) and locationId (actual location).
Enum Values
| Property | Value |
|---|---|
| » taskType | RECEIVE |
| » taskType | LOAD |
| » taskType | PICK |
| » taskType | PUT_AWAY |
| » taskType | OTHER |
| » loadMode | LIVE_LOAD |
| » loadMode | PRE_LOAD |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"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 | RGeneralTaskView |