API Docs
YMS API
Task Management
POST Start Task

POST Start Task

Introduction

Initiates the execution of a yard task, marking it as in-progress and recording the start time. This API is called when an assigned user begins working on a task such as loading, unloading, or moving equipment. The task status transitions from pending to active, enabling time tracking and progress monitoring for yard operations.

API Request

POST /general-task/{taskId}/start

Request Parameters

NameLocationTypeRequiredDescription
taskIdpathstringYesnone
X-Tenant-IDheaderstringNonone
X-Yard-IDheaderstringNonone
Item-Time-ZoneheaderstringNonone
AuthorizationheaderstringNonone

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 CodeDefinitionDescriptionData Model
200OK (opens in a new tab)noneRGeneralTaskView