查询库位列表 | 仙工智能帮助中心

帮助中心主页

RDS 多机器人调度系统

查询库位列表

接口介绍

此 API可以查询所有库位列表

请求

功能：查询库位列表
方法：POST
接口说明：/api/work-sites/sites

json

POST "http://host:8080/api/work-sites/sites"

请求参数

Name	Type	Description	Required
siteId	String	库位ID	否
area	String	库位所属区域	否
locked	int	库位锁定状态（0：未锁定，1：锁定）	否
lockedBy	String	锁定库位的对象	否
filled	int	库位占用状态（0：未占用，1：占用）	否
disabled	int	库位禁用状态（0：未禁用，1：禁用）	否
syncFailed	int	库位同步状态（0：未同步失败，1：同步失败）	否
content	String	库位货物内容	否
type	int	库位类型（0：逻辑库位，1：物理库位，即地图上实际存在的库位）	否
groupName	String	库区名	否

请求示例

查询被占用且未被锁定的所有库位

json

{
    "filled": 1,
    "locked": 0
}

1
2
3
4

响应

Name	Type	Description
code	int	API 错误码，详情见 API 错误码
msg	String	API 错误码信息
data	Object	返回的数据对象
id	String	表示库位的 id，用于系统识别库位
siteId	String	表示当前库位的库位名称
locked	int	表示当前库位是否被锁定
lockedBy	String	表示当前库位是被谁锁定
filled	int	表示当前库位是否有货
disabled	int	表示当前库位是否禁用
syncFailed	int	表示当前库位是否同步失败
content	String	表示库位的货物内容
area	String	表示当前库位所在区域
rowNum	String	表示当前库位所在排
colNum	String	表示当前库位所在列
level	String	表示当前库位所在层
depth	String	表示当前库位所在深度
no	String	表示当前库位编号
agvId	String	表示正在使用库位的机器人id
tags	String	表示当前库位的标签
type	int	表示当前库位的类型（0：逻辑库位，1：物理库位）
groupName	String	表示当前库位所在的库区

响应数据示例

Responses Code 200

json

{
   "code":200,
   "msg":"Success",
   "data":[
      {
         "id":"402888a47f305d53017f305d8c560000",
         "siteId":"B01",
         "locked":0,
         "lockedBy":"",
         "filled":1,
         "disabled":0,
         "syncFailed":0,
         "content":"",
         "area":"new",
         "rowNum":null,
         "colNum":null,
         "level":null,
         "depth":null,
         "no":null,
         "agvId":null,
         "tags":null,
         "type":1,
         "groupName":"filled"
      },
      {
         "id":"402888a47f305d53017f305d8c860001",
         "siteId":"B02",
         "locked":0,
         "lockedBy":"",
         "filled":1,
         "disabled":0,
         "syncFailed":0,
         "content":"",
         "area":"new",
         "rowNum":null,
         "colNum":null,
         "level":null,
         "depth":null,
         "no":null,
         "agvId":null,
         "tags":null,
         "type":1,
         "groupName":"filled"
      }
   ]
}