API Docs
YMS API
Data Models
General Task
General Task View

GeneralTaskView

{
  "id": 0,
  "taskId": "string",
  "taskType": "RECEIVE",
  "timeStatus": "NOT_STARTED",
  "startTime": "string",
  "lastPauseTime": "string",
  "endTime": "string",
  "totalRunTime": 0,
  "totalPausedTime": 0,
  "createdTime": "string",
  "updatedTime": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "assignUserName": "string",
  "plannedLocationId": "string",
  "assignLocationId": "string",
  "assignLocationName": "string",
  "customerId": "string",
  "customerName": "string",
  "entryId": "string",
  "loadIds": [
    "string"
  ],
  "receiptIds": [
    "string"
  ],
  "taskStatus": "NEW",
  "assigneeUserId": "string",
  "description": "string",
  "priority": "string",
  "note": "string",
  "lastStepAssignedUserIds": [
    "string"
  ],
  "planedLastStepAssignedUserIds": [
    "string"
  ],
  "lastStepAssignedUserNames": [
    "string"
  ],
  "planedLastStepAssignedUserNames": [
    "string"
  ],
  "lastStepId": "string",
  "planedAssignAllSteps": true
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenonenone
taskIdstringfalsenonenone
taskTypestringfalsenonenone
timeStatusstringfalsenonenone
startTimestringfalsenonenone
lastPauseTimestringfalsenonenone
endTimestringfalsenonenone
totalRunTimeinteger(int64)falsenonenone
totalPausedTimeinteger(int64)falsenonenone
createdTimestringfalsenonenone
updatedTimestringfalsenonenone
createdBystringfalsenonenone
updatedBystringfalsenonenone
assignUserNamestringfalsenonenone
plannedLocationIdstringfalsenonenone
assignLocationIdstringfalsenonenone
assignLocationNamestringfalsenonenone
customerIdstringfalsenonenone
customerNamestringfalsenonenone
entryIdstringfalsenonenone
loadIds[string]falsenonenone
receiptIds[string]falsenonenone
taskStatusstringfalsenonenone
assigneeUserIdstringfalsenonenone
descriptionstringfalsenonenone
prioritystringfalsenoneTask priority level (from WMS)
notestringfalsenoneTask notes or remarks (from WMS)
lastStepAssignedUserIds[string]falsenoneUser IDs assigned to the last step
planedLastStepAssignedUserIds[string]falsenonePlanned user IDs assigned to the last step
lastStepAssignedUserNames[string]falsenoneUser names assigned to the last step
planedLastStepAssignedUserNames[string]falsenonePlanned user names assigned to the last step
lastStepIdstringfalsenonenone
planedAssignAllStepsbooleanfalsenonenone

Enum Values

PropertyValue
taskTypeRECEIVE
taskTypeLOAD
taskTypePICK
taskTypePUT_AWAY
taskTypeOTHER
timeStatusNOT_STARTED
timeStatusRUNNING
timeStatusPAUSED
timeStatusCOMPLETED
taskStatusNEW
taskStatusIN_PROGRESS
taskStatusEXCEPTION
taskStatusNEEDS_APPROVAL
taskStatusCLOSED
taskStatusFORCE_CLOSED
taskStatusCANCELLED