1. 设备分类设置API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
1.1 | 新增记录 | /v1/iot/device/setting/add | 1.0 |
1.2 | 修改分类 | /v1/iot/device/setting/update | 1.0 |
1.3 | 删除分类 | /v1/iot/device/setting/remove | 1.0 |
1.4 | 分类列表 | /v1/iot/device/setting/tree | 1.0 |
API调用
1.1: 新增菜单记录
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/device/setting/add
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
name | body | string | y | 分类名称 |
pid | body | int | n | 父id |
orgId | body | String | y | 业务组织id |
pname | body | String | n | 父节点名 |
grade | body | int | y | 级别1:专业,2:系统, 3:分类 |
请求Body描述(非Form表单数据)
{
"name": "",
"pid": 0,
"orgId":"123",
"pname":"xx",
"grade" : 2
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.2: 修改分类
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/device/setting/update
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
name | body | string | y | 记录名称 |
id | body | int | y | 主键id |
请求Body描述(非Form表单数据)
{
"id": 1,
"name": ""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.3: 删除分类
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/device/setting/remove 方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | y | 主键id |
请求Body描述(非Form表单数据)
{
"id": 1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
code:200,
message:"success",
data:{}
}
1.4: 分类列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/device/setting/tree
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
orgId | body | String | y | 业务组织id |
请求Body描述(非Form表单数据)
{
"orgId":"111"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
message | 顶层 | STRING | y | 响应消息文本 |
data | 顶层 | JSONArray | y | 专业集合 |
id | data | Integer | y | 专业id |
name | data | string | y | 专业名称 |
grade | data | int | y | 树状级别:值为1,1为专业级别 |
children | data | JSONArray | y | 系统集合 |
id | children | String | y | 系统id |
pid | children | String | y | 父id |
name | children | String | y | 系统名称 |
id | children | String | y | 系统名称 |
pid | children | String | y | 父id |
grade | children | Integer | y | 树状级别:值为2, 2为系统级别 |
children | children | JSONArray | y | 分类集合 |
id | children | Integer | y | 分类id |
pid | children | String | y | 父id |
name | children | String | y | 分类名称 |
grade | children | String | y | 树状级别:值为3, 3为分类级别 |
typeId | children | String | y | 分类id |
返回结果示例
{
code:200,
message:"success",
data:[
{
id:1,
name:"给排水",
grade:1,
children:[
{
id:22,
pid:1,
name:"给水系统",
grade:2,
children:[
{
id:33,
pid:22,
name: "A1生活水泵",
grade:3,
typeId : 1122
}
]
},{
id:23,
pid:22,
name:"排水系统",
grade:2,
type:[...]
}
...
]
} ,
{
id:2,
name: "消防",
grade :2,
system:[...],
}
...
]
}