1. 规则分类API

API列表

编号 API名称 路径 版本
1.1 新增分类 /v1/iot/rule/category/add 1.0
1.2 分类详情 /v1/iot/rule/category/detail 1.0
1.3 修改分类 /v1/iot/rule/category/update 1.0
1.4 删除分类 /v1/iot/rule/category/remove 1.0
1.5 分类列表 /v1/iot/rule/category/list 1.0
1.6 分类列表 /v1/iot/rule/category/page 1.0

API调用

1.1: 新增分类

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/category/add

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
orderNo body int y 分类排序号
pid body int n 父id
authOrgId body int y 业务组织id（左上角业务组织节点的id，用于数据隔离）

请求Body描述(非Form表单数据)

{
    "name": "",
    "orderNo": "",
    "pid": 0,
    "authOrgId":12990
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.2: 分类详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/category/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 分类名称
orderNo data int y 分类排序号
pid data int n 父id
id data int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "name": "",
    "orderNo": "",
    "pid": 0
  }
}

1.3: 修改分类

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/category/update

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
orderNo body int y 分类排序号
pid body int n 父id
id body int y 主键id
authOrgId body int y 业务组织id（左上角业务组织节点的id，用于数据隔离）

请求Body描述(非Form表单数据)

{
    "id": 1,
    "name": "",
    "orderNo": "",
    "pid": 0,
    "authOrgId":12900
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.4: 删除分类

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/category/remove

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 主键id

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.5: 分类列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/category/list

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int n 主键
pid body int n 分类主键
name body STRING n 名称模糊查询
authOrgId body int y 业务组织id（左上角业务组织节点的id，用于数据隔离）

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
name records string y 分类名称
orderNo records int y 分类排序号
pid records int n 父id
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "",
            "orderNo": "",
            "pid": 0
        }
      ]
  }
}

1.6: 分类分页列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/category/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 每页条数
pageNo body int y 当前页数
id body int n 主键
pid body int n 分类主键
name body STRING n 名称模糊查询
authOrgId body int y 业务组织id（左上角业务组织节点的id，用于数据隔离）

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
total data int y 总条数
records data Array y 列表
name records string y 分类名称
orderNo records int y 分类排序号
pid records int n 父id
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "",
            "orderNo": "",
            "pid": 0
        }
      ]
  }
}

results matching ""

    No results matching ""