帮助中心
帮助中心主页
安装与部署
开发与集成
RDS脚本方法字典
分页查询库位列表

接口介绍

API可以分页查询库位列表

请求

  • 功能:分页查询库位列表
  • 方法:POST
  • 接口说明:/api/work-sites/sitesPageAble
json
POST "http://host:8080/api/work-sites/sitesPageAble"
1

请求参数

NameTypeDescriptionRequired
currentPageint表示查询第 currentPage 页的结果
pageSizeint表示按照每页 pageSize 条记录,对所有结果进行分页
queryParamObject查询参数对象
siteIdString库位ID
areaString库位所属区域
lockedint库位锁定状态(0:未锁定,1:锁定)
lockedByString锁定库位的对象
filledint库位占用状态(0:未占用,1:占用)
disabledint库位禁用状态(0:未禁用,1:禁用)
syncFailedint库位同步状态(0:未同步失败,1:同步失败)
contentString库位货物内容
typeint库位类型(0:逻辑库位,1:物理库位,即地图上实际存在的库位)
groupNameString库区名

请求示例

json
{
    "currentPage":2,
    "pageSize":2,
    "queryParam": {
        "filled":0,
        "locked":1
    }
}
1
2
3
4
5
6
7
8

响应

NameTypeDescription
codeintAPI 错误码,详情见 API 错误码
msgStringAPI 错误码信息
dataObject返回的数据对象
totalCountint表示查询到的任务的总数
currentPageint表示当前结果的页码
pageSizeint示当前页可记录的任务的最大数量
totalPageint示查询到的所有任务,总共被分成了 totalPage 页
pageListList记录了若干条任务信息
idString表示库位的 id,用于系统识别库位
siteIdString表示当前库位的库位名称
lockedint表示当前库位是否被锁定
lockedByString表示当前库位是被谁锁定
filledint表示当前库位是否有货
disabledint表示当前库位是否禁用
syncFailedint表示当前库位是否同步失败
contentString表示库位的货物内容
areaString表示当前库位所在区域
rowNumString表示当前库位所在排
colNumString表示当前库位所在列
levelString表示当前库位所在层
depthString表示当前库位所在深度
noString表示当前库位编号
agvIdString表示正在使用库位的机器人id
tagsString表示当前库位的标签
typeint表示当前库位的类型(0:逻辑库位,1:物理库位)
groupNameString表示当前库位所在的库区

响应数据示例

Responses Code 200

json
{
    "code": 200,
    "msg": "Success",
    "data": {
        "totalCount": 28,
        "currentPage": 2,
        "pageSize": 2,
        "totalPage": 14,
        "pageList": [
            {
                "id": "40289fa2804b090b01804b092b750003",
                "siteId": "B04",
                "locked": 0,
                "lockedBy": "",
                "filled": 0,
                "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": "40289fa2804b090b01804b092b780004",
                "siteId": "B05",
                "locked": 0,
                "lockedBy": "",
                "filled": 0,
                "disabled": 0,
                "syncFailed": 0,
                "content": "",
                "area": "new",
                "rowNum": null,
                "colNum": null,
                "level": null,
                "depth": null,
                "no": null,
                "agvId": null,
                "tags": null,
                "type": 1,
                "groupName": "klj"
            }
        ]
    }
}
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
最近更新 2022/11/28
文章内容

接口介绍

请求

请求参数

请求示例

响应

响应数据示例

Responses Code 200