|
@@ -1,37 +1,15 @@
|
|
# 报警系统接口文档
|
|
# 报警系统接口文档
|
|
|
|
|
|
-## 系统接口
|
|
|
|
|
|
+## 总体说明(重要,必看)
|
|
|
|
|
|
|
|
+>注:userId、groupCode、projectId必须传值,appId可以为空)
|
|
|
|
+>除报警条目查询外,groupCode = 0 代表查询所有集团的数据,projectId = 0 代表查询所有项目的数据,appId = 0 代表查询所有子系统的数据
|
|
>
|
|
>
|
|
-> 注:userId、groupCode、projectId必须传值,appId可以为空)
|
|
|
|
-> 除报警条目查询外,groupCode = 0 代表查询所有集团的数据,projectId = 0 代表查询所有项目的数据,appId = 0 代表查询所有子系统的数据
|
|
|
|
->
|
|
|
|
-> 请求方法:POST
|
|
|
|
|
|
+>请求方法:POST
|
|
>
|
|
>
|
|
-> **重要:除特殊说明外,本文档中所有的查询接口入参,请参照[通用查询](/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": "always" // 有效期类型
|
|
|
|
- }
|
|
|
|
-}
|
|
|
|
-```
|
|
|
|
|
|
+## API
|
|
|
|
|
|
### 报警条目
|
|
### 报警条目
|
|
|
|
|
|
@@ -42,6 +20,7 @@
|
|
> projectId,appId = 0的查询规则与groupCode相同
|
|
> projectId,appId = 0的查询规则与groupCode相同
|
|
|
|
|
|
#### query
|
|
#### query
|
|
|
|
+
|
|
请求参数:
|
|
请求参数:
|
|
|
|
|
|
```json5
|
|
```json5
|
|
@@ -110,6 +89,7 @@
|
|
请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
|
|
|
|
#### query
|
|
#### query
|
|
|
|
+
|
|
请求参数:
|
|
请求参数:
|
|
|
|
|
|
```json5
|
|
```json5
|
|
@@ -168,6 +148,7 @@
|
|
```
|
|
```
|
|
|
|
|
|
#### create
|
|
#### create
|
|
|
|
+
|
|
请求参数:
|
|
请求参数:
|
|
|
|
|
|
```json
|
|
```json
|
|
@@ -181,6 +162,7 @@
|
|
```
|
|
```
|
|
|
|
|
|
#### update
|
|
#### update
|
|
|
|
+
|
|
请求参数:
|
|
请求参数:
|
|
|
|
|
|
```json
|
|
```json
|
|
@@ -193,7 +175,9 @@
|
|
"condition": {}
|
|
"condition": {}
|
|
}
|
|
}
|
|
```
|
|
```
|
|
|
|
+
|
|
#### delete
|
|
#### delete
|
|
|
|
+
|
|
请求参数:
|
|
请求参数:
|
|
|
|
|
|
```json
|
|
```json
|
|
@@ -316,6 +300,7 @@
|
|
#### update
|
|
#### update
|
|
|
|
|
|
请求参数
|
|
请求参数
|
|
|
|
+
|
|
```json5
|
|
```json5
|
|
{
|
|
{
|
|
"id": "1", // 必填
|
|
"id": "1", // 必填
|
|
@@ -337,6 +322,7 @@
|
|
#### batch_update
|
|
#### batch_update
|
|
|
|
|
|
一次最多更新200条
|
|
一次最多更新200条
|
|
|
|
+
|
|
```json5
|
|
```json5
|
|
{
|
|
{
|
|
"alarmConfigs": [
|
|
"alarmConfigs": [
|
|
@@ -350,13 +336,47 @@
|
|
#### delete
|
|
#### delete
|
|
|
|
|
|
请求参数
|
|
请求参数
|
|
|
|
+
|
|
```json5
|
|
```json5
|
|
{
|
|
{
|
|
"id": "1"
|
|
"id": "1"
|
|
}
|
|
}
|
|
```
|
|
```
|
|
|
|
|
|
|
|
+#### batch_delete
|
|
|
|
|
|
|
|
+请求参数
|
|
|
|
+
|
|
|
|
+```
|
|
|
|
+{
|
|
|
|
+ "alarmConfigs": [
|
|
|
|
+ {
|
|
|
|
+ "id": "1"
|
|
|
|
+ }
|
|
|
|
+ ]
|
|
|
|
+}
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+#### 报警条件约定格式
|
|
|
|
+
|
|
|
|
+```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": "always" // 有效期类型
|
|
|
|
+ }
|
|
|
|
+}
|
|
|
|
+```
|
|
|
|
|
|
### 报警记录
|
|
### 报警记录
|
|
|
|
|
|
@@ -542,6 +562,22 @@
|
|
}
|
|
}
|
|
```
|
|
```
|
|
|
|
|
|
|
|
+#### batch_update
|
|
|
|
+
|
|
|
|
+请求参数
|
|
|
|
+
|
|
|
|
+```json5
|
|
|
|
+{
|
|
|
|
+ alarmRecordModels: [
|
|
|
|
+ {
|
|
|
|
+ // 参考update参数
|
|
|
|
+ }
|
|
|
|
+ ]
|
|
|
|
+}
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
### 报警批注
|
|
### 报警批注
|
|
|
|
|
|
请求路径:/alarm/comment/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
请求路径:/alarm/comment/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
|
|
@@ -601,5 +637,4 @@
|
|
使用[数据标准化](/dic/dic_api.md)接口
|
|
使用[数据标准化](/dic/dic_api.md)接口
|
|
|
|
|
|
|
|
|
|
-字典类型的type字段请参照 [报警数据字典](/alarm/alarm_dict.md) 菜单括号里的英文
|
|
|
|
-
|
|
|
|
|
|
+字典类型的type字段请参照 [报警数据字典](/alarm/alarm_dict.md) 菜单括号里的英文
|