获取组织机构或子节点下设备列表
接口功能
获取组织机构,分页获取子节点设备列表
请求地址
https://open.qly.cmviot.cn/v3/open/api/node/tree请求方式
POST,需要鉴权
请求参数
| 参数名称 | 参数类型 | 是否必需 | 参数含义 | 说明 |
|---|---|---|---|---|
| queryType | int | Y | 查询类型 | 0-节点,1-设备 |
| nodeId | String | N | 节点编码 | 1:为空时查询根节点的子节点 2:传入叶子节点时查询节点下设备列表 |
| deviceId | String | N | 设备 mac | 1:单传设备 mac 查询设备绑定的节点信息 2:设备只支持查询绑定的父节点 |
| up | int | N | 查询方向 | 默认向下查询,1-向上查询,只适用于查询父节点 |
| page | int | N | 页码,默认 1 | 仅叶子节点查询设备列表使用 |
| pageSize | int | N | 分页大小,默认 10,最大为 100 | 仅叶子节点查询设备列表使用 |
| queryRegion | String | N | 下级企业 region | 只通过 region 查询时,默认返回该企业的根节点信息。如果 up 传 1(即向上查询)就查询该企业在上级企业的虚拟节点信息(必须保证级联关系为单链路,且最上级为应开平台企业,否则返回无权限)。 |
参数组合说明
1.三个参数都不传:查询根节点的下层节点 2.传了 deviceId,不传其他参数,只查询设备的父节点
| 查询目的 | nodeId | deviceId | up | queryType | queryRegion |
|---|---|---|---|---|---|
| 根据最底层节点查询设备信息 | √ | × | × | 1 | × |
| 查询下级组织架构节点 | √ | × | × | 0 | × |
| 根据设备查询上级节点 | × | √ | × | 0 | × |
| 根据节点查询上级节点 | √ | × | √ | 0 | × |
| 根据 queryRegion 查询该企业根节点(用户可根据该根节点向下查询) | × | × | × | 0 | √ |
| 根据 queryRegion 查询该企业在上级企业对应的虚拟节点(用户可根据该根虚拟节点向上向下查询) | × | × | √ | 0 | √ |
请求示例
{
"queryType": 0
}响应参数
子节点列表响应参数说明
| 参数名称 | 参数类型 | 说明 | 备注 |
|---|---|---|---|
| nodeId | String | 节点编码 | |
| nodeName | String | 节点名称 | |
| parentId | String | 父节点编码 | |
| hasParent | int | 是否含有父节点 | 0-否,1-是 |
| hasChild | int | 是否含有子节点 | 0-否,1-是 |
| region | String | 下级企业 reigon | 当节点是下级级联企业根节点对应的虚拟节点时返回 |
叶子节点设备列表响应参数说明
| 参数名称 | 参数类型 | 说明 | 备注 |
|---|---|---|---|
| deviceId | String | 设备 mac | |
| deviceName | String | 设备名称 | |
| createTime | long | 设备绑定时间 |
响应示例
子节点列表响应
{
"resultCode": "000000",
"resultMsg": "成功",
"data": {
"node": [
{
"nodeId": "123456",
"nodeName": "测试二级节点",
"hasParent": 1,
"hasChild": 1
}
]
}
}叶子节点设备列表响应
{
"resultCode": "000000",
"resultMsg": "成功",
"data": {
"device": [
{
"deviceId": "xxxxS_123345",
"deviceName": "测试xxx",
"createTime": 1755155675000
}
]
}
}