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

帮助中心主页

SRD API 协议

获取运单序列的集合

请求

功能：获取运单序列的集合
方法：GET
接口说明：/orderSequences/{NAME}

json

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

参数介绍

Name	Type	Description
pageNo	integer	页面索引(Default value : 1)
pageSize	integer	页面包含运单序列的最大数量
intendedVehicle	string	以预期执行运单序列的机器人的名称，对运单进行筛选
processingVehicle	string	以实际执行运单序列的机器人的名称，对运单进行筛选
category	string	以运单序列的业务类型，对运单进行筛选
namePrefix	string	运单序列的名称前缀
orderNamePrefix	string	运单的名称前缀
complete	boolean	运单序列是否已关闭运单入口
failureFatal	boolean	如果为 true，序列中任一运单被撤销并达到 FAILED 终态后，SRD 将撤销该序列中的其他所有运单，并关闭序列入口

使用参数的请求示例：

json

GET "http://localhost:7100/api/route/orderSequences?pageNo=1&complete=true"

响应

Responses Code 200

响应示例

json

{
  "pageNo": 1,
  "pageSize": 1,
  "page": [
    {
      "name": "Sequence-01",
      "orders": [
        "Order-01"
      ],
      "complete": true,
      "finished": true,
      "failureFatal": true,
      "finishedIndex": 0,
      "category": "Park",
      "intendedVehicle": "AMB-01",
      "processingVehicle": "AMB-01"
    }
  ],
  "total": 1
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

参数释义

Name	Type	Description	Example
pageNo*	integer	页面索引
pageSize*	integer	每页包含运单序列的条数
page*		运单序列数据页面
name	string	运单序列的名称	Sequence-01
orders	string	序列包含的运单的名称	Order-01
complete	boolean	序列是否已经关闭运单入口。若未关闭，则可以继续添加新的运单
finished	boolean	序列是否已经完成
failureFatal	boolean	如果为 true，序列中任一运单被撤销并达到 FAILED 终态后，SRD 将撤销该序列中的其他所有运单，并关闭序列入口
finishedIndex	integer	最近一个已达终态的运单，在序列中的索引。当该值为 -1 时，表示该序列尚未被执行
category	**	运单序列的业务类型
intendedVehicle	string($nullable)	预期执行此运单序列的机器人名称	AMB-01
processingVehicle	string($nullable)	实际执行此运单序列的机器人名称	AMB-01
total*	integer	运单序列的总数量