API Docs
YMS API
Data Models
Shuttle Task
Shuttle Task View

ShuttleTaskView

{
  "taskId": "string",
  "taskStatus": "NEW",
  "prioritize": true,
  "equipmentType": "VEHICLE",
  "equipmentId": "string",
  "fromLocationId": "string",
  "toLocationId": "string",
  "assigneeId": "string",
  "createdTime": "string",
  "updatedTime": "string",
  "plannedStartTime": "string",
  "plannedEndTime": "string",
  "taskStartTime": "string",
  "taskEndTime": "string",
  "shuttleStartTime": "string",
  "shuttleEndTime": "string",
  "shuttleBy": "string",
  "notes": "string",
  "photos": [
    "string"
  ],
  "exceptionType": "EQUIPMENT_NOT_FOUND",
  "exceptionReason": "string",
  "cancelReason": "string",
  "equipmentBeforeUpdate": {
    "equipmentNo": "string",
    "equipmentId": "string",
    "equipmentStatus": "UNKNOWN",
    "equipmentType": "VEHICLE",
    "trailerSize": "OTHER",
    "containerSize": "SIZE_53",
    "equipmentCondition": "UNKNOWN",
    "sealNumber": "string",
    "locationId": "string",
    "locationName": "string"
  },
  "equipmentAfterUpdate": {
    "equipmentNo": "string",
    "equipmentId": "string",
    "equipmentStatus": "UNKNOWN",
    "equipmentType": "VEHICLE",
    "trailerSize": "OTHER",
    "containerSize": "SIZE_53",
    "equipmentCondition": "UNKNOWN",
    "sealNumber": "string",
    "locationId": "string",
    "locationName": "string"
  },
  "fromLocationName": "string",
  "fromLocationGroupName": "string",
  "toLocationName": "string",
  "toLocationGroupName": "string",
  "equipmentNo": "string",
  "assigneeUserName": "string",
  "shuttleByName": "string",
  "equipmentCondition": "UNKNOWN",
  "isPinned": false,
  "pinnedTime": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
taskIdstringfalsenoneTask ID
taskStatusstringfalsenoneTask Status
prioritizebooleanfalsenoneTask Priority
Indicates whether this task has high priority
true: high priority task, processed first
false: normal priority task
equipmentTypestringfalsenoneEquipment Type
equipmentIdstringfalsenoneEquipment ID
fromLocationIdstringfalsenoneSource Location ID
toLocationIdstringfalsenoneTarget Location ID
assigneeIdstringfalsenoneTask Assignee ID
createdTimestringfalsenoneCreate Time
updatedTimestringfalsenoneUpdate Time
plannedStartTimestringfalsenonePlanned Start Time
plannedEndTimestringfalsenonePlanned End Time
taskStartTimestringfalsenoneActual Task Start Time
taskEndTimestringfalsenoneActual Task End Time
shuttleStartTimestringfalsenoneShuttle Start Time
shuttleEndTimestringfalsenoneShuttle End Time
shuttleBystringfalsenoneShuttle Operator
notesstringfalsenoneAdditional Notes
photos[string]falsenonePhoto List
exceptionTypestringfalsenoneException Type
exceptionReasonstringfalsenoneException Reason
cancelReasonstringfalsenoneCancel Reason
The reason why the task was canceled when task status is CANCELED
equipmentBeforeUpdateEquipmentVersionRecord (opens in a new tab)falsenoneEquipment information before update
equipmentAfterUpdateEquipmentVersionRecord (opens in a new tab)falsenoneEquipment information after update
fromLocationNamestringfalsenoneSource Location Name
fromLocationGroupNamestringfalsenoneSource Location Group Name
toLocationNamestringfalsenoneTarget Location Name
toLocationGroupNamestringfalsenoneTarget Location Group Name
equipmentNostringfalsenoneEquipment Number
assigneeUserNamestringfalsenonenone
shuttleByNamestringfalsenonenone
equipmentConditionstringfalsenonenone
isPinnedbooleanfalsenoneIs pinned
Whether the user has pinned this shuttle task, defaults to false
pinnedTimestringfalsenonePinned Time
The time when the shuttle task was pinned, used for sorting pinned tasks

Enum Values

PropertyValue
taskStatusNEW
taskStatusIN_PROGRESS
taskStatusCLOSED
taskStatusFORCE_CLOSED
taskStatusCANCELED
equipmentTypeVEHICLE
equipmentTypeTRAILER
equipmentTypeCHASSIS
equipmentTypeCONTAINER
equipmentTypeFLATBED
equipmentTypeOTHER
equipmentTypeNO_EQUIPMENT
exceptionTypeEQUIPMENT_NOT_FOUND
exceptionTypeLOCATION_OCCUPIED
exceptionTypeTO_LOCATION_MODIFY
exceptionTypeFORCE_CLOSE
exceptionTypeUPDATE_EQUIPMENT_INFORMATION
equipmentConditionUNKNOWN
equipmentConditionGOOD
equipmentConditionDAMAGED