2. 规则等级API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
2.1 | 新增规则等级 | /v1/iot/rule/level/add | 1.0 |
2.2 | 规则等级详情 | /v1/iot/rule/level/detail | 1.0 |
2.3 | 修改规则等级 | /v1/iot/rule/level/update | 1.0 |
2.4 | 删除规则等级 | /v1/iot/rule/level/remove | 1.0 |
2.5 | 规则等级列表 | /v1/iot/rule/level/list | 1.0 |
API调用
2.1: 新增规则等级
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/rule/level/add
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
name | body | string | y | 等级名称 |
authOrgId | body | int | y | 业务组织id(左上角业务组织节点的id,用于数据隔离) |
请求Body描述(非Form表单数据)
{
"name": "普通",
"authOrgId":12900
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
2.2: 设备规则等级详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/rule/level/detail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | y | 主键id |
请求Body描述(非Form表单数据)
{
"id": 1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
message | 顶层 | STRING | y | 响应消息文本 |
data | 顶层 | JSONObject | y | 响应数据对象 |
name | data | string | y | 规则等级名称 |
id | data | int | y | 主键id |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"name": "普通",
"id": 1
}
}
2.3: 修改规则等级
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/rule/level/update
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
name | body | string | y | 规则等级名称 |
id | body | int | y | 主键id |
authOrgId | body | int | y | 业务组织id(左上角业务组织节点的id,用于数据隔离) |
请求Body描述(非Form表单数据)
{
"id": 1,
"name": "严重",
"authOrgId":12900
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
2.4: 删除规则等级
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/rule/level/remove
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | y | 主键id |
请求Body描述(非Form表单数据)
{
"id": 1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
2.5: 规则等级列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/rule/level/list
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
authOrgId | body | int | y | 业务组织id(左上角业务组织节点的id,用于数据隔离) |
请求Body描述(非Form表单数据)
{
"authOrgId":12900
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
records | data | Array | 是 | 列表 |
name | records | string | y | 规则等级名称 |
id | records | int | y | 主键id |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"records": [
{
"id": 1,
"name": "严重"
}
]
}
}