API Docs
YMS API
Data Models
General Task
General Task Create CMD

GeneralTaskCreateCmd

{
  "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"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
taskIdstringfalsenoneTask ID (Optional)
If specified, this ID will be used; if not specified, it will be auto-generated
taskTypestringtruenoneTask Type
assignUserNamestringfalsenoneAssignee
assignLocationIdstringfalsenoneAssigned Location
During internal processing, this will be assigned to both plannedLocationId and locationId)
customerIdstringfalsenoneCustomer ID
receiptIds[string]falsenonenone
loadIds[string]falsenonenone
entryIdstringfalsenonenone
assigneeUserIdstringfalsenonenone
loadModestringfalsenonenone
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
equipmentIdstringfalsenoneEquipment ID for event publishing
Used to avoid database query when publishing task lifecycle events

Enum Values

PropertyValue
taskTypeRECEIVE
taskTypeLOAD
taskTypePICK
taskTypePUT_AWAY
taskTypeOTHER
loadModeLIVE_LOAD
loadModePRE_LOAD