|
@@ -9,27 +9,47 @@
|
|
|
|
|
|
#### 查询
|
|
|
|
|
|
-分页,排序等通用操作请参照
|
|
|
-[通用查询](/utils/query.md)。
|
|
|
-本文档的入参只包含通用查询的criteria部分
|
|
|
+**重要:除特殊说明外,本文档中所有的接口入参,请参照[通用查询](/utils/query.md)格式,本文档的入参只包含通用查询的criteria部分**
|
|
|
+
|
|
|
+### 报警条件
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "configs": { // 用户页面的配置信息
|
|
|
+ "aerfa": 0.3,
|
|
|
+ "beita": 3,
|
|
|
+ "type": "1", //0:默认;1:自定义
|
|
|
+ },
|
|
|
+ "infoCode": ["X", "Y", "PClose"], // 触发和恢复条件中包含的信息点
|
|
|
+ // 设备多开示例:
|
|
|
+ "trigger": "(X>(1-0.3)*Y) && (X-Y) > seq.max(seq.list(decimal(PClose),decimal(1)))", // 触发条件,
|
|
|
+ "end": "!((X>(1-0.3)*Y) && (X-Y) > seq.max(seq.list(decimal(PClose),decimal(1))))", // 恢复条件
|
|
|
+ "triggerUphold": 45, // 触发条件持续时长
|
|
|
+ "endUphold": 5, // 结束条件持续时长
|
|
|
+ "effectTime": { // 有效期
|
|
|
+ "type": "period", // 有效期类型
|
|
|
+ "period": {
|
|
|
+ "startTime": "090000",
|
|
|
+ "endTime": "210000",
|
|
|
+ }
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
|
|
|
### 查询报警条目
|
|
|
|
|
|
请求路径:/alarm/item/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
|
|
|
|
-(注:condition 为 query)
|
|
|
-
|
|
|
请求参数:
|
|
|
|
|
|
-```json
|
|
|
+```json5
|
|
|
{
|
|
|
"id": "1",
|
|
|
- "code": "1033",
|
|
|
+ "code": "1033", // 条目编码
|
|
|
"name": "测试报警",
|
|
|
- "category": "消防报警",
|
|
|
- "level": "S",
|
|
|
+ "category": "Env", // 报警类型
|
|
|
+ "level": "S", // 报警等级
|
|
|
"remark": "测试数据",
|
|
|
- "dealFun": "test_deal_fun",
|
|
|
+ "dealFun": "test_deal_fun", // 处理算法
|
|
|
"createUser": "test",
|
|
|
"createTime": 1602962584000,
|
|
|
"updateUser": "test",
|
|
@@ -94,9 +114,8 @@
|
|
|
查询字段:
|
|
|
{
|
|
|
"id": "1",
|
|
|
- "itemCode": "1033",
|
|
|
+ "itemCode": "1033",
|
|
|
"classCode": "OBJ_AX_CODE",
|
|
|
- "condition": {}, //额外写文档
|
|
|
"concern": 1,
|
|
|
"open": 2,
|
|
|
"createUser": "test",
|
|
@@ -130,25 +149,29 @@
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 查询报警定义
|
|
|
+### 报警定义
|
|
|
|
|
|
请求路径:/alarm/config/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
|
|
|
|
+(注:condition 为 query,create,update,delete)
|
|
|
+
|
|
|
+#### query
|
|
|
+
|
|
|
请求参数:
|
|
|
|
|
|
-```json
|
|
|
+```json5
|
|
|
{
|
|
|
"id": "1",
|
|
|
- "objId": "OBJ_1",
|
|
|
- "classCode": "ACATAH",
|
|
|
+ "objId": "OBJ_1", // 报警对象id
|
|
|
+ "classCode": "ACATAH", // 报警对象所属对象类
|
|
|
"projectId": "PRJ_WD_001",
|
|
|
- "itemCode": "1033",
|
|
|
- "category": "消防报警",
|
|
|
- "level": "S",
|
|
|
+ "itemCode": "1033", // 报警条目编码
|
|
|
+ "category": "Env", // 报警类型
|
|
|
+ "level": "S", // 报警等级
|
|
|
"remark": "测试数据",
|
|
|
- "open": 1,
|
|
|
- "concern": 1,
|
|
|
- "userDefined": 1,
|
|
|
+ "open": 1, // 是否屏蔽, 0:屏蔽,1:不屏蔽
|
|
|
+ "concern": 1, // 关注程度(敏感度)
|
|
|
+ "userDefined": 1, // 用户自定义标志
|
|
|
"createUser": "test",
|
|
|
"createTime": 1602962781000,
|
|
|
"updateUser": "test",
|
|
@@ -157,9 +180,9 @@
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-返回值
|
|
|
+查询返回值
|
|
|
|
|
|
-```json
|
|
|
+```json5
|
|
|
{
|
|
|
"result": "success",
|
|
|
"data": [
|
|
@@ -171,7 +194,7 @@
|
|
|
"itemCode": "1008",
|
|
|
"category": "Eq",
|
|
|
"level": "S",
|
|
|
- "condition": {
|
|
|
+ "condition": { // 报警条件
|
|
|
"end": "faultStatus<0.5",
|
|
|
"time": {
|
|
|
"type": "period",
|
|
@@ -200,20 +223,76 @@
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 查询报警记录
|
|
|
+#### create
|
|
|
+
|
|
|
+请求参数
|
|
|
+
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "objId": "OBJ_1", // 必填
|
|
|
+ "classCode": "ACATAH", // 必填
|
|
|
+ "itemCode": "1033", // 必填
|
|
|
+ "level": "S",
|
|
|
+ "remark": "测试数据",
|
|
|
+ "open": 1,
|
|
|
+ "concern": 1,
|
|
|
+ "userDefined": 1,
|
|
|
+ "createUser": "test",
|
|
|
+ "createTime": 1602962781000,
|
|
|
+ "updateUser": "test",
|
|
|
+ "updateTime": 1602962783000,
|
|
|
+ "valid": 1
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+#### update
|
|
|
+
|
|
|
+请求参数
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "id": "1", // 必填
|
|
|
+ "itemCode": "1033",
|
|
|
+ "level": "S",
|
|
|
+ "remark": "测试数据",
|
|
|
+ "open": 1,
|
|
|
+ "concern": 1,
|
|
|
+ "userDefined": 1,
|
|
|
+ "createUser": "test",
|
|
|
+ "createTime": 1602962781000,
|
|
|
+ "updateUser": "test",
|
|
|
+ "updateTime": 1602962783000,
|
|
|
+ "valid": 1
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+#### delete
|
|
|
+
|
|
|
+请求参数
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "id": "1"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+### 报警记录
|
|
|
|
|
|
-请求路径:/alarm/record/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
|
+请求路径:/alarm/record/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
|
|
|
|
+(注:condition 为 query,create,update)
|
|
|
+
|
|
|
+#### query
|
|
|
|
|
|
请求参数:
|
|
|
|
|
|
-```json
|
|
|
+```json5
|
|
|
{
|
|
|
"id": "1",
|
|
|
- "itemCode": "1033",
|
|
|
+ "itemCode": "1033", // 条目编码
|
|
|
"projectId": "PRJ_WD_001",
|
|
|
- "objId": "OBJ_1",
|
|
|
- "level": "S",
|
|
|
+ "objId": "OBJ_1", // 报警对象id
|
|
|
+ "level": "S", // 报警等级
|
|
|
"remark": "测试数据",
|
|
|
"name": '报警名称',
|
|
|
"category": '报警分类',
|
|
@@ -286,29 +365,140 @@
|
|
|
}
|
|
|
```
|
|
|
|
|
|
+#### create
|
|
|
+
|
|
|
+请求参数
|
|
|
+
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "id": "957cc32c-8579-480e-b7ce-37b6c45c1a06", // 如果创建时未传入id,系统自动生成id;否则使用传入的值;
|
|
|
+ "itemCode": "1005", // 条目编码,必填
|
|
|
+ "objId": "Eq1101050029a90b5c93692e49c68bd27174ba9f7169", // 报警对象id,必填
|
|
|
+ "classCode": "WSDWPP", // 报警对象所属对象类,必填
|
|
|
+ "level": "S", // 报警等级,必填
|
|
|
+ "remark": "东坝万达地下二层 设备-S8L8M 13m³/h - 90m - 5.5kW-B2产生报警",
|
|
|
+ "name": "生活给水水泵 产生报警", // 报警名称,必填
|
|
|
+ "category": "Eq", // 报警类型,必填
|
|
|
+ "concern": 0,
|
|
|
+ "state": 2,
|
|
|
+ "createUser": "system",
|
|
|
+ "condition": { // 报警条件
|
|
|
+ "end": "onlineStatus<0.5",
|
|
|
+ "trigger": "onlineStatus>0.5",
|
|
|
+ "infoCode": [
|
|
|
+ "onlineStatus"
|
|
|
+ ],
|
|
|
+ "endUphold": 0,
|
|
|
+ "infoCodes": [
|
|
|
+ {
|
|
|
+ "funcId": "901",
|
|
|
+ "meterId": "WSDWPP_21_onlineStatus",
|
|
|
+ "infoCode": "onlineStatus"
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "triggerUphold": 0
|
|
|
+ },
|
|
|
+ "triggerInfo": { // 报警触发信息
|
|
|
+ "onlineStatus": 1
|
|
|
+ },
|
|
|
+ "triggerTime": 1605853815000, // 触发时间
|
|
|
+ "endInfo": { // 报警恢复信息
|
|
|
+ "onlineStatus": 0
|
|
|
+ },
|
|
|
+ "endTime": 1605855610000, // 恢复时间
|
|
|
+ "createTime": 1605854329000,
|
|
|
+ "updateUser": "system",
|
|
|
+ "updateTime": 1605855628000,
|
|
|
+ "valid": 1,
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+#### update
|
|
|
+
|
|
|
+请求参数
|
|
|
+
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "id": "957cc32c-8579-480e-b7ce-37b6c45c1a06", // 必填
|
|
|
+ "remark": "东坝万达地下二层 设备-S8L8M 13m³/h - 90m - 5.5kW-B2产生报警",
|
|
|
+ "name": "生活给水水泵 产生报警", // 报警名称,必填
|
|
|
+ "state": 2,
|
|
|
+ "triggerInfo": { // 报警触发信息
|
|
|
+ "onlineStatus": 1
|
|
|
+ },
|
|
|
+ "triggerTime": 1605853815000, // 触发时间
|
|
|
+ "endInfo": { // 报警恢复信息
|
|
|
+ "onlineStatus": 0
|
|
|
+ },
|
|
|
+ "endTime": 1605855610000, // 恢复时间
|
|
|
+ "createTime": 1605854329000,
|
|
|
+ "updateUser": "system",
|
|
|
+ "updateTime": 1605855628000,
|
|
|
+ "valid": 1,
|
|
|
+ "nature": "报警性质",
|
|
|
+ "treat_mode": "处理方式",
|
|
|
+ "treat_state": "处理状态",
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
### 报警批注
|
|
|
|
|
|
请求路径:/alarm/comment/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
|
|
|
|
(注:condition 为 query,create)
|
|
|
|
|
|
+#### query
|
|
|
+
|
|
|
请求参数:
|
|
|
|
|
|
-```json
|
|
|
-查询字段:
|
|
|
+```json5
|
|
|
{
|
|
|
"id": "1",
|
|
|
- "record_id": "1033",
|
|
|
- "content": 1,
|
|
|
+ "recordId": "1033", // 报警记录id
|
|
|
+ "content": 1, // 批注内容
|
|
|
"createUser": "TEST",
|
|
|
"createTime": 1602953249000,
|
|
|
"updateTime": 1602953249000,
|
|
|
"updateUser": "TEST",
|
|
|
"valid": 1
|
|
|
}
|
|
|
-新增:
|
|
|
+```
|
|
|
+
|
|
|
+返回值
|
|
|
+
|
|
|
+```json5
|
|
|
{
|
|
|
- "record_id": "1033",
|
|
|
+ "result": "success",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "id": "037bab48-5e4f-4b31-840b-7f0f3e18efff",
|
|
|
+ "recordId": "将以便于",
|
|
|
+ "content": "00266eb0-be08-4c81-9521-765d4f567f63",
|
|
|
+ "createUser": "systemId",
|
|
|
+ "createTime": 1605770036000,
|
|
|
+ "projectId": "Pj1101050029",
|
|
|
+ "groupCode": "WD"
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "count": 44
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+#### create
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```json5
|
|
|
+{
|
|
|
+ "recordId": "1033",
|
|
|
"content": "内容"
|
|
|
}
|
|
|
-```
|
|
|
+```
|
|
|
+
|
|
|
+### 报警字典
|
|
|
+
|
|
|
+使用[数据标准化](/dic/dic_api.md)接口
|
|
|
+
|
|
|
+
|
|
|
+字典类型的type字段请参照 [报警数据字典](/alarm/alarm_dict.md) 菜单括号里的英文
|
|
|
+
|