API Docs
YMS API
Task Management
POST Pause Task

POST Pause Task

Introduction

Temporarily suspends an active yard task, allowing the assigned user to halt work without completing or canceling the task. This API is used when operations need to be interrupted due to breaks, equipment issues, or priority changes. The task can later be resumed from where it was paused, maintaining all progress and time tracking information.

API Request

POST /general-task/{taskId}/pause

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