5. 设备模板事件API

API列表

编号 API名称 路径 版本
5.1 新增设备模板事件 /v1/iot/thing/model/event/add 1.0
5.2 设备模板事件详情 /v1/iot/thing/model/event/detail 1.0
5.3 修改设备模板事件 /v1/iot/thing/model/event/update 1.0
5.4 删除设备模板事件 /v1/iot/thing/model/event/remove 1.0
5.5 设备模板事件列表 /v1/iot/thing/model/event/list 1.0
5.6 设备模板事件分页 /v1/iot/thing/model/event/page 1.0

API调用

5.1: 新增设备模板事件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/event/add

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
code body string y 编码
level body string n 级别，信息：1，告警：2，故障：3
description body string n 描述
productId body int y 模板ID

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

{
    "name": "",
    "code": "",
    "level": "",
  "productId": 1,
  "description": ""
}

返回信息

返回参数类型

JSON

返回参数

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

5.2: 设备模板事件详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/event/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 分类名称
code data string y 编码
level data string n 级别
description data string n 描述
productId data int y 模板ID
id data int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "name": "",
    "code": "",
    "level": "",
    "productId": 1,
    "description": ""
  }
}

5.3: 修改设备模板事件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/event/update

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
code body string y 编码
level body string n 级别
description body string n 描述
productId body int y 模板ID
id body int y 主键id

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

{
    "id": 1,
    "name": "",
  "code": "",
  "level": "",
  "productId": 1,
  "description": ""
}

返回信息

返回参数类型

JSON

返回参数

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

5.4: 删除设备模板事件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/event/remove

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

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

5.5: 设备模板事件列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/event/list

方法：POST

请求参数

名称 位置 类型 必填 描述

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
name data string y 分类名称
code data string y 编码
level data string n 级别
description data string n 描述
productId data int y 模板ID
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "",
      "code": "",
      "level": "",
      "productId": 1,
      "description": ""
        }
      ]
  }
}

5.6: 设备模板事件分页列表/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/event/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 每页条数
pageNo body int y 当前页数

请求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 data string y 分类名称
code data string y 编码
level data string n 级别
description data string n 描述
productId data int y 模板ID
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "",
      "code": "",
      "level": "",
      "productId": 1,
      "description": ""
        }
      ]
  }
}

results matching ""

    No results matching ""