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.
API Request
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",
"lastStepAssignedUserIds": [
"string"
],
"planedLastStepAssignedUserIds": [
"string"
],
"lastStepAssignedUserNames": [
"string"
],
"planedLastStepAssignedUserNames": [
"string"
],
"lastStepId": "string",
"planedAssignAllSteps": true,
"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 |
| body | body | GeneralTaskCreateCmd | No | none |
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 |