终止运单
请求
- 功能：终止特定
id的运单，或终止指定机器人当前运单/所有运单 - 方法：
POST - 接口说明：
/terminate
json
POST "http://host:8088/terminate"
1
请求数据
终止运单有多种形式，发送时可以选择其中一种形式发送：
- 终止单个运单
- 终止多个运单
- 终止指定机器人运单
终止运单，默认 disableVehicle为 true
终止单个运单
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | 运单 ID | 是 |
| disableVehicle | bool | 指示执行此运单的机器人后续是否接单的标识，true=执行此运单的机器人在此运单终止后不再接单，false=此运单终止后依然可以继续接单。可不填，默认为true | 否 |
终止单个运单
| Name | Type | Description | Required |
|---|---|---|---|
| idList | string array | 运单 ID 列表 | 是 |
| disableVehicle | bool | 指示执行此运单的机器人后续是否接单的标识，true=执行此运单的机器人在此运单终止后不再接单，false=此运单终止后依然可以继续接单。可不填，默认为true | 否 |
当 idList为空 json array 时，终止所有运单
终止指定机器人运单
| Name | Type | Description | Required |
|---|---|---|---|
| vehicles | string array | 机器人名列表 | 是 |
| disableVehicle | bool | 指示执行此运单的机器人后续是否接单的标识，true=执行此运单的机器人在此运单终止后不再接单，false=此运单终止后依然可以继续接单。可不填，默认为true | 否 |
| clearAll | bool | 是否清除此机器人所接的所有运单，所有运单指的是正在执行的当前运单和已经分配给该车还未执行的运单。可不填，默认为false，即只终止当前运单。 此接口还未测试 | 否 |
终止故障机器人当前执行运单，并且运单报60017错误
待开发
此 api 用于车子发生故障后，需要换机器人重新执行该运单。RDS 会依据运单的 60019 错误码，重新生成一个相同内容，不同 id 运单，重新选车执行。此问题机器人后续是不接单。
| Name | Type | Description | Required |
|---|---|---|---|
| problemVehicle | string | 问题机器人名称 | 是 |
请求示例
终止单个运单，并使机器人继续接单
json
{
"id": "task1", // task id
"disableVehicle": false
}
1
2
3
4
2
3
4
终止单个运单，并使机器人不再接单
json
{
"id": "task1" // task id
}
1
2
3
2
3
终止多个运单，并使机器人继续接单
json
{
"idList": ["task1", "task2"], // task id list
"disableVehicle": false
}
1
2
3
4
2
3
4
终止多个运单，并使机器人不再接单
json
{
"idList": ["task1", "task2"] // task id list
}
1
2
3
2
3
终止特定机器人当前运单，并使机器人继续接单
json
{
"vehicles": ["vehicle1", "vehicle2"], // 车名数组
"disableVehicle": false
}
1
2
3
4
2
3
4
终止特定机器人所有运单，并使机器人继续接单
json
{
"vehicles": ["vehicle1", "vehicle2"], // 车名数组
"clearAll": true, // 终止所有任务
"disableVehicle": false
}
1
2
3
4
5
2
3
4
5
响应
响应数据
| Name | Type | Description |
|---|---|---|
| code | int | API 错误码，详情见 API 错误码 |
| msg | string | API 错误码信息 |
| create_on | string | API 上传时间戳 |
响应示例
Responses Code 200
成功响应
json
{
"code": 0,
"create_on": "2022-02-10T18:21:25.073Z",
"msg": "ok"
}
1
2
3
4
5
2
3
4
5
Responses Code 400
请求 body 不为 json
json
{
"code": 50000,
"create_on": "2022-02-10T18:21:25.073Z",
"msg": "parse json error"
}
1
2
3
4
5
2
3
4
5
RDSCore 没有 XXX 机器人的控制权
json
{
"code": 50003,
"create_on": "2022-05-09T19:53:12.437Z",
"msg": "vehicle XXX not locked"
}
1
2
3
4
5
2
3
4
5
同时只能填 id/idList/vehicles 中的一种字段
json
{
"code": 50001,
"create_on": "2022-08-15T15:15:32.706Z",
"msg": "only one of id/idList/vehicles can be used at a time"
}
1
2
3
4
5
2
3
4
5
id 不为 string
json
{
"code": 50001,
"create_on": "2022-08-15T15:16:31.442Z",
"msg": "id must be string"
}
1
2
3
4
5
2
3
4
5
vehicles 不为 array
json
{
"code": 50001,
"create_on": "2022-08-15T15:17:05.869Z",
"msg": "vehicles must be array"
}
1
2
3
4
5
2
3
4
5
vehicles 不为 string array
json
{
"code": 50001,
"create_on": "2022-08-15T15:17:25.677Z",
"msg": "vehicles must be string array"
}
1
2
3
4
5
2
3
4
5
idList 不为 array
json
{
"code": 50001,
"create_on": "2022-08-15T15:18:22.639Z",
"msg": "idList must be array"
}
1
2
3
4
5
2
3
4
5
idList 不为 string array
json
{
"code": 50001,
"create_on": "2022-08-15T15:18:46.125Z",
"msg": "idList must be string array"
}
1
2
3
4
5
2
3
4
5
最近更新 2022/11/28
感谢反馈有用
感谢反馈没用
