4. 规则模板API

API列表

编号	API名称	路径	版本
4.1	新增规则模板	/v1/iot/rule/template/add	1.0
4.2	规则模板详情	/v1/iot/rule/template/detail	1.0
4.3	修改规则模板	/v1/iot/rule/template/update	1.0
4.4	删除规则模板	/v1/iot/rule/template/remove	1.0
4.5	规则模板分页	/v1/iot/rule/template/page	1.0
4.6	规则模板列表	/v1/iot/rule/template/list	1.0
4.7	规则模板禁启用	/v1/iot/rule/template/switch	1.0
4.8	规则模板类型列表	/v1/iot/rule/template/type/list	1.0

API调用

4.1: 新增规则模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/add

方法：POST

请求参数

名称	位置	类型	必填	描述
ruleTemplateName	body	string	y	规则模板名称
templateId	body	int	y	设备模板Id
templateName	body	string	y	设备模板名称
eventSource	body	string	n	事件来源
ruleCategoryPid	body	int	y	事件分类Id
ruleCategoryId	body	int	y	事件类型Id
ruleLevelId	body	int	y	事件等级Id
cycleTime	body	int	y	检测周期(单位秒)
ruleTemplateType	body	string	y	规则模板类型
conditionRel	body	string	y	规则与或关系 and/or
conditions	body	JSONArray	y	规则条件
authOrgId	body	int	y	业务组织id（左上角业务组织节点的id，用于数据隔离）
ruleType	conditions	string	y	设备属性（property）/设备事件（event）
propertyId	conditions	string	n	设备属性id或设备事件属性id(ruleType=property时需传）
propertyName	conditions	string	n	设备属性名字(ruleType=property）
propertyCode	conditions	string	y	设备属性名字
eventId	conditions	string	n	设备事件id(ruleType=event时需传）
eventCode	conditions	string	n	设备事件Code(ruleType=event时需传）
eventName	conditions	string	n	设备事件名(ruleType=event时需传）
triggerType	conditions	string	y	触发类型即时=immediate/持续=continued
duration	conditions	string	n	持续时间
compare	conditions	string	y	比较符号(eq、ne、gt、lt、ge、le)
dataType	conditions	string	y	数据类型
propertyValue	conditions	string	y	结果值

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

{
    "ruleTemplateName": "",
    "templateId": 1,
    "templateName": "xxx",
    "eventSource":"xx",
    "ruleCategoryPid":111,
    "ruleCategoryId": 11,
    "ruleLevelId": 1,
    "cycleTime": 60,
    "ruleTemplateType": "abnormal",
    "conditionRel": "and",
    "conditions":[{
        "ruleType":"property",
        "propertyName":"status",
        "propertyCode":"设备状态",
        "propertyId":121,
        "triggerType":"immediate",
        "duration":0,
        "compare":"eq",
        "dataType":"string",
        "propertyValue":"off"
    }]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.2: 规则模板详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/detail

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	y	响应码标识
message	顶层	STRING	y	响应消息文本
data	顶层	JSONObject	y	响应数据对象
ruleTemplateName	data	string	y	规则模板名称
templateId	data	int	y	设备模板Id
templateName	data	string	y	设备模板名称
eventSource	data	string	n	事件来源
ruleCategoryPid	data	int	y	事件分类Id
ruleCategoryId	data	int	y	事件类型Id
ruleLevelId	data	int	y	事件等级Id
cycleTime	data	int	y	检测周期(单位秒)
ruleTemplateType	body	string	y	规则模板类型
conditionRel	data	string	y	规则与或关系 and/or
conditions	data	JSONArray	y	规则条件
ruleType	conditions	string	y	设备属性（property）/设备事件（event）
propertyName	conditions	string	n	设备属性名字(ruleType=property）
propertyId	conditions	string	n	设备属性id或设备事件属性id(ruleType=property时需传）
eventId	conditions	string	n	设备事件id(ruleType=event时需传）
eventCode	conditions	string	n	设备事件Code(ruleType=event时需传）
triggerType	conditions	string	y	触发类型即时=immediate/持续=continued
duration	conditions	string	n	持续时间
compare	conditions	string	y	比较符号(eq、ne、gt、lt、ge、le)
dataType	conditions	string	y	数据类型
propertyValue	conditions	string	y	结果值

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
    "ruleTemplateName": "",
    "templateId": 1,
    "templateName": "xxx",
    "eventSource":"xx",
    "ruleCategoryPid":111,
    "ruleCategoryId": 11,
    "ruleLevelId": 1,
    "cycleTime": 60,
    "ruleTemplateType": "others",
    "conditionRel": "and",
    "conditions":[{
        "ruleType":"property",
        "propertyName":"status",
        "eventId":121,
        "eventCode":"immediate",
        "duration":0,
        "compare":"eq",
        "dataType":"string",
        "propertyValue":"off"
    }]
  }
}

4.3: 修改规则模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/update

方法：POST

请求参数

名称	位置	类型	必填	描述
ruleTemplateName	body	string	y	规则模板名称
templateId	body	int	y	设备模板Id
templateName	body	string	y	设备模板名称
eventSource	body	string	n	事件来源
ruleCategoryPid	body	int	y	事件分类Id
ruleCategoryId	body	int	y	事件类型Id
ruleLevelId	body	int	y	事件等级Id
cycleTime	body	int	y	检测周期(单位秒)
ruleTemplateType	body	string	y	规则模板类型
conditionRel	body	string	y	规则与或关系 and/or
conditions	body	JSONArray	y	规则条件
authOrgId	body	int	y	业务组织id（左上角业务组织节点的id，用于数据隔离）
ruleType	conditions	string	y	设备属性（property）/设备事件（event）
propertyName	conditions	string	n	设备属性名字(ruleType=property）
propertyId	conditions	string	n	设备属性id或设备事件属性id(ruleType=property时需传）
eventId	conditions	string	n	设备事件id(ruleType=event时需传）
eventCode	conditions	string	n	设备事件Code(ruleType=event时需传）
triggerType	conditions	string	y	触发类型即时=immediate/持续=continued
duration	conditions	string	n	持续时间
compare	conditions	string	y	比较符号(eq、ne、gt、lt、ge、le)
dataType	conditions	string	y	数据类型
propertyValue	conditions	string	y	结果值
id	body	int	y	主键id

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

{
        "id": 1,
        "ruleTemplateName": "",
        "templateId": 1,
        "templateName": "xxx",
        "eventSource":"xx",
        "ruleCategoryPid":111,
        "ruleCategoryId": 11,
        "ruleLevelId": 1,
        "cycleTime": 60,
        "ruleTemplateType": "scene",
        "conditionRel": "and",
        "conditions":[{
            "ruleType":"property",
            "propertyName":"status",
            "propertyId":121,
            "triggerType":"immediate",
            "duration":0,
            "compare":"eq",
            "dataType":"string",
            "propertyValue":"off"
        }]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.4: 删除规则模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/remove

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.5: 规则模板分页

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/page

方法：POST

请求参数

名称	位置	类型	必填	描述
ruleCategoryPId	body	Integer	n	事件分类Id
ruleCategoryId	body	Integer	n	事件类型Id
ruleLevelId	body	Integer	n	事件等级Id
ruleTemplateName	body	String	n	规则模板名称
pageNo	body	Integer	n	页码
pageSize	body	Integer	n	页大小
productId	body	String	n	产品id
ruleTemplateType	body	JSONArray	n	规则模板类型
authOrgId	body	Integer	y	业务组织id（左上角业务组织节点的id，用于数据隔离）

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

{
    "ruleTemplateName": "测试规则模板"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
total	data	int	是	列表长度
records	data	Array	是	列表
id	records	int	y	规则id
ruleTemplateName	records	string	y	规则模板名称
templateId	records	int	y	模板Id
templateName	records	string	y	模板名称
eventSource	records	string	y	事件来源
ruleCategoryPId	records	int	y	事件分类Id
ruleCategoryPName	records	string	y	事件分类名称
ruleCategoryId	records	int	y	事件类型Id
ruleCategoryName	records	string	y	事件类型名称
ruleLevelId	records	int	y	事件等级Id
ruleLevelName	records	string	y	事件等级名称
ruleTemplateType	records	string	y	规则模板类型
ruleTemplateTypeName	records	string	y	规则模板类型名称
status	records	string	y	状态 0禁用，1启用

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
    "total": 123
      "records": [
          {
            "id": 1,
            "ruleTemplateName": "",
            "templateId": 1,
            "templateName": "测试设备模板名",
            "eventSource":"xx",
            "ruleCategoryPid":111,
            "ruleCategoryPName":"测试分类名",
            "ruleCategoryId": 11,
            "ruleCategoryName": "测试类型名",
            "ruleLevelId": 1,
            "ruleLevelName": "测试时间等级名",
            "ruleTemplateType": "others",
            "ruleTemplateTypeName": "测试模板类型类型名",
            "status": 60,
        }
      ]
  }
}

4.6: 规则模板列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/list

方法：POST

请求参数

名称	位置	类型	必填	描述
status	body	String	n	状态
productId	body	String	n	产品id
authOrgId	body	int	int	业务组织id（左上角业务组织节点的id，用于数据隔离）

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

{
    "status": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
records	data	Array	是	列表
id	records	int	y	规则id
ruleTemplateName	records	string	y	规则模板名称
templateId	records	int	y	模板Id
templateName	records	string	y	模板名称
eventSource	records	string	y	事件来源
ruleCategoryPId	records	int	y	事件分类Id
ruleCategoryPName	records	string	y	事件分类名称
ruleCategoryId	records	int	y	事件类型Id
ruleCategoryName	records	string	y	事件类型名称
ruleLevelId	records	int	y	事件等级Id
ruleLevelName	records	string	y	事件等级名称
ruleTemplateType	records	string	y	规则模板类型
ruleTemplateTypeName	records	string	y	规则模板类型名称
status	records	string	y	状态 0禁用，1启用

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "ruleTemplateName": "",
            "templateId": 1,
            "templateName": "测试设备模板名",
            "eventSource":"xx",
            "ruleCategoryPid":111,
            "ruleCategoryPName":"测试分类名",
            "ruleCategoryId": 11,
            "ruleCategoryName": "测试类型名",
            "ruleLevelId": 1,
            "ruleLevelName": "测试时间等级名",
            "ruleTemplateType": "others",
            "ruleTemplateTypeName": "测试模板类型类型名",
            "status": 60,
        }
      ]
  }
}

4.7: 规则模板禁启用

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/switch

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	int	y	主键id
status	body	string	y	状态 0禁用，1启用

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

{
    "id": 1,
    "status": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.8: 规则模板类型列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/template/type/list

方法：POST

请求参数

名称	位置	类型	必填	描述

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

{
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
message	顶层	STRING	是	响应消息文本
data	顶层	JSONObject	是	响应数据对象
records	data	Array	是	列表
ruleTemplateType	records	string	y	规则模板类型 abnormal、scene、others
ruleTemplateTypeName	records	string	y	规则模板类型名称

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "records": [{
        "ruleTemplateType" : "abnormal"
        "ruleTemplateTypeName" : "设备异常规则模板"
        }
    ]
  }
}

4. 规则模板API

API列表

API调用

4.1: 新增规则模板

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.2: 规则模板详情

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.3: 修改规则模板

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.4: 删除规则模板

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.5: 规则模板分页

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.6: 规则模板列表

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.7: 规则模板禁启用

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

4.8: 规则模板类型列表

描述

请求信息

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

results matching ""

No results matching ""