设备分组api
# 说明
设备分组的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询分组列表。
分组查询会将分组以及分组下的展示设备一起查询出来,除非设置自动补全autopopulate为false,将只查出自身
接口版本
v1接口地址
/api-web-v1/device-groups
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | page | number | false | 分页第几页 | 1 | |
query | limit | number | false | 单页几条数据 | 10 | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"page":"1",
"limit":"2",
"sort":"sort"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | 设备总条数 |
-rows | array | False | 当前返回的设备对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 4,
"rows": [{
"tags": [],
"groupClass": "63ef0db59f44f55d4d3bc329",
"devices":[...此分组下展示设备完整信息],
"name":"3楼",
"scenes":[],
"show":true,
"sort":1,
"creator": {
"_id": "62c51f57d8a1bd26a35482e0",
"trueName": "宁波迦南智能电气股份有限公司",
"username": "nb_jnzn"
},
"_id": "63ef0dc19f44f5702f3bc32a"
}]
}
}
# 查询单个设备分组
接口说明
根据查询条件查询单个设备。
接口版本
v1接口地址
/api-web-v1/device-groups/one
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"name":"3楼"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"groupClass": "63ef0db59f44f55d4d3bc329",
"devices":[...此分组下展示设备完整信息],
"name":"3楼",
"scenes":[],
"show":true,
"sort":1,
"creator": {
"_id": "62c51f57d8a1bd26a35482e0",
"trueName": "宁波迦南智能电气股份有限公司",
"username": "nb_jnzn"
},
"_id": "63ef0dc19f44f5702f3bc32a"
}
}
# 查询设备分组ID
接口说明
根据设备ID查询设备
接口版本
v1接口地址
/api-v1/device-groups/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 设备ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"_id": "63ef0dc19f44f5702f3bc32a"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"groupClass": "63ef0db59f44f55d4d3bc329",
"devices":[...此分组下展示设备完整信息],
"name":"3楼",
"scenes":[],
"show":true,
"sort":1,
"creator": {
"_id": "62c51f57d8a1bd26a35482e0",
"trueName": "宁波迦南智能电气股份有限公司",
"username": "nb_jnzn"
},
"_id": "63ef0dc19f44f5702f3bc32a"
}
}
# 新建
接口说明
新建一个分组。第三方不建议直接调用分组新建接口,此接口创建需实际设备。
接口版本
v1接口地址
/api-v1/device-groups
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 分组对象字段说明 |
第三方不建议直接调用设备新建接口,此接口创建需实际设备。文档不提供新增在线调试
# 编辑
接口说明
修改分组。第三方不建议直接调用分组修改接口,此接口使用需实际设备。
接口版本
v1接口地址
/api-v1/device-groups/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的分组ID |
body | - | Object | True | 分组对象字段说明 |
第三方不建议直接调用设备修改接口,此接口修改需实际设备。文档不提供修改在线调试
# 删除
接口说明
删除一个分组。第三方不建议直接调用分组删除接口,此接口需实际设备。
接口版本
v1接口地址
/api-v1/device-groups/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的分组ID |
请求参数举例
只需发送删除设备的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
message | string | false | 成功删除返回complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
第三方不建议直接调用分组删除接口,此接口需实际设备。文档不提供删除在线调试