使用指定名称创建一个新的运单序列
请求
- 功能:使用指定名称创建一个新的运单序列
- 方法:
POST
- 接口说明:
/orderSequences/{NAME}
json
POST "http://host:7100/api/route/orderSequences/{NAME}"
1
运单序列介绍:
- 创建运单序列,在一个序列中,机器人将依次执行完所有的运单
- 当序列中的运单入口处于开放状态时,可以向序列动态添加运单(提交运单时,通过
wrappingSequence
指定所属序列) - 通过
POST /orderSequences/{NAME}/markComplete
接口,可以关闭序列的运单入口。 - 当机器人执行完序列中最后一个运单,且序列的运单入口处于开放状态时,机器人将原地等待,不去往任何地点或执行任何操作。
- 当机器人执行完序列中最后一个运单,且序列的运单入口处于关闭状态时,序列将处于终态
(finished == true)
。
参数介绍
Name | Type | Description |
---|---|---|
intendedVehicle | string | 弃用! |
category | string | (可选)运单序列内整体的业务类型 |
failureFatal | boolean | (可选)如果为 true,序列中任一运单被撤销并达到 FAILED 终态后,SRD 将撤销该序列中的其他所有运单,并关闭序列入口 |
complete | boolean | (可选)是否关闭序列的运单入口。若未关闭,则可以继续添加新的运单 |
transports* | 运单包含的目标工作站的序列 | |
name* | string | 运单名称 |
order* | 运单细节 | |
deadline* | string($date-time) | 执行运单的截止时间(UTC时区) |
intendedVehicle | string | (可选)预期执行此运单的机器人名称 |
category | string | (可选)运单的业务类型 |
wrappingSequence | string | (可选)运单所属的运单序列。当此项被指定时,运单将添加至指定的序列 |
destinations* | string | 运单包含的目标工作站的序列 |
locationName* | string | 目标工作站的名称 |
operation* | string | 机器人在工作站要执行的操作的名称 |
properties* | string | 运单子任务的元属性 |
properties* | string | 运单的元属性 |
dependencies* | string | 运单依赖。执行本运单前,需要已经执行完毕的运单的名称列表 |
properties* | string | 运单序列的元属性 |
请求示例
json
{
"intendedVehicle": "AMB-01",
"category": "Park",
"failureFatal": true,
"complete": false,
"transports": [
{
"name": "Order-01",
"order": {
"deadline": "2018-05-17T06:42:40.396Z",
"intendedVehicle": "AMB-01",
"category": "Park",
"wrappingSequence": "Sequence-01",
"destinations": [
{
"locationName": "LOC-AP1",
"operation": "Wait",
"properties": [
{
"key": "duration",
"value": "2000"
}
]
}
],
"properties":[],
"dependencies": []
}
],
"properties": []
}
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
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
响应
Responses Code 200
响应示例
json
请求已成功
1
Responses Code 404
响应示例
json
[
"Unknown location 'Storage 01'."
]
1
2
3
2
3
Responses Code 409
响应示例
json
[
"Order sequence 'Sequence-01' already exists."
]
1
2
3
2
3
Responses Code 500
响应示例
json
[
"string"
]
1
2
3
2
3
最近更新 2022/11/28
有帮助
没帮助