获取运单集合 | 仙工智能帮助中心

帮助中心主页

SRD API 协议

获取运单集合

请求

功能：获取运单的集合
方法：GET
接口说明：/transportOrders

json

GET "http://host:7100/api/route/transportOrders"

参数介绍

Name	Type	Description
intendedVehicle	string	以预期执行运单的机器人的名称，对运单进行筛选
processingVehicle	string	以实际执行运单的机器人的名称，对运单进行筛选
category	string	以运单的业务类型，对运单进行筛选
state	string	以运单的状态，对运单进行筛选，支持多选
pageNo	integer	页面索引(Default value : 1)
pageSize	integer	页面包含运单的最大数量
regexp	integer	通过名称筛选运单的正则表达式

使用参数的请求示例：

json

GET "http://host:7100/api/route/transportOrders?intendedVehicle=test"

使用多个参数的请求示例：

json

GET "http://host:7100/api/route/transportOrders?category=test&pageNo=1"

响应

Responses Code 200

响应示例

json

{
  "pageNo": 1,
  "pageSize": 1,
  "page": [
    {
      "name": "TOrder-01",
      "category": "Park",
      "creationTime": "2018-05-17T06:42:40.396Z",
      "deadline": "2018-05-17T06:42:40.396Z",
      "finishedTime": "2018-05-17T06:42:40.396Z",
      "state": "RAW",
      "intendedVehicle": "AMB-01",
      "processingVehicle": "AMB-01",
      "destinations": [
        {
          "locationName": "Storage-01",
          "operation": "Store",
          "state": "PRISTINE",
          "properties": [
            {
              "key": "key1",
              "value": "value1"
            }
          ]
        }
      ],
      "dependencies": [
        "TOrder-002"
      ],
      "wrappingSequence": "Sequence-0001",
      "dispensable": true
    }
  ],
  "total": 1
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

参数释义

Name	Type	Description	Example
PageNo*	integer	minimum: 1 maximum: 2147483647 页面索引	1
pageSize*	integer	minimum: 1 maximum: 2147483647 每页包含运单数据的条数	1
Page*	array	minItems: 0_maxItems: 2147483647 运单数据页面	-
name	string	运单的名称	TOrder-01
category	string	运单的业务类型	Park
creationTime	string($date-time)	运单的创立时间（UTC时区）	2018-05-17T06:42:40.396Z
deadline	string($date-time)	运单的截止时间（UTC时区）	2018-05-17T06:42:40.396Z
finishedTime	stringnull($date-time)	运单的完成时间（UTC时区）。为 null 时表示运单未完成。	_ 2018-05-17T06:42:40.396Z_
state	string	运单当前的状态 RAW：原始状态，等待处理。 ACTIVE：运单各目的地均是路线可达，订单已处于激活状态。 DISPATCHABLE：运单信息无误，路线规划完成，等待系统分配机器人。 BEING_PROCESSED：运单正在被执行。 WITHDRAWN：运单正在被撤回。 FINISHED：终态，运单已经执行成功。 FAILED：终态，运单已经被撤回，并且被标记为失败。 UNROUTABLE：终态。SRD 系统无法为此运单规划路线。出现此状态时，请检查场景的线路拓扑结构。
intendedVehicle	string($nullable)	预期执行此运单的机器人名称	AMB-01
processingVehicle	string($nullable)	实际执行此运单的机器人名称	AMB-01
destinations		minItems: 1_maxItems: 2147483647 运单包含的目标工作站的序列
locationName*	string	工作站的名称	Storage-01
operation*	string	机器人在工作站要执行的操作的名称	Store
state*	array	运单子任务的执行状态 PRISTINE：子任务处于初始状态 ACTIVE：子任务处于激活状态 TRAVELLING：机器人正在去子任务目标点过程中 OPERATING：机器人已经到达子任务目标点，正在执行操作 FINISHED：子任务已完成 FAILED：子任务已失败
properties	string	minItems: 0_maxItems: 2147483647 运单子任务的元属性
dependencies	string	minItems: 0_maxItems: 2147483647 运单依赖。执行本运单前，需要已经执行完毕的运单的名称列表	TOrder-002]
wrappingSequence	string($nullable)	运单所归属的运单序列	Sequence-0001
dispensable	boolean	是否为非必要的运单
total*	integer	运单数据的总数量	1