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 /general-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"
}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 | 任务ID（可选） |
| » taskType | body | string | Yes | 任务类型 |
| » assignUserName | body | string | No | 指派人 |
| » assignLocationId | body | string | No | 指派地点 |
| » customerId | body | string | No | 客户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 | none |
| » priority | body | string | No | Task priority level (from WMS) |
| » note | body | string | No | Task notes or remarks (from WMS) |
Detailed Description
» taskId: 任务ID（可选） 如果指定，则使用该ID；如果不指定，则自动生成
» assignLocationId: 指派地点 在内部处理时会同时赋值给plannedLocationId(计划位置)和locationId(实际位置)
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 |