Forráskód Böngészése

添加报警系统

wudla 4 éve
szülő
commit
403769b7ad
1 módosított fájl, 16 hozzáadás és 32 törlés
  1. 16 32
      docs/alarm/alarm_api.md

+ 16 - 32
docs/alarm/alarm_api.md

@@ -2,11 +2,18 @@
 
 ## 系统接口
 
+### (注:condition 为 query,create,update,delete)
+
+### (注:为了读写分离,serviceid还会变动,请不要写死)
+
+### (注:userId、groupCode、projectId必须传值,appId可以为空)
+
+#### 请求方法:POST
 #### 查询
 
-[通用查询](http://git.sagacloud.cn/persagy/persagy-dmp-doc/src/master/api_document/通用查询.md)
+[通用查询](/utils/query.md)
 
-#### 报警条目
+#### 报警条目(注:condition 为 query)
 
 请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -30,7 +37,7 @@
 }
 ```
 
-#### 报警匹配规则
+#### 报警匹配规则(注:condition 为 query,create,update,delete)
 
 请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -42,6 +49,7 @@
   "id": "1",
   "itemCode": "1033",
   "classCode": "OBJ_AX_CODE",
+  "condition": {} //额外写文档
   "createUser": "test",
   "createTime": 1602963135000,
   "updateUser": "test",
@@ -67,7 +75,7 @@
 }
 ```
 
-#### 报警定义
+#### 报警定义(注:condition 为 query,update)
 
 请求路径:/alarm/config/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -82,6 +90,7 @@
   "itemCode": "1033",
   "category": "消防报警",
   "level": "S",
+  "condition": {} //额外写文档
   "remark": "测试数据",
   "open": 1,
   "concern": 1,
@@ -92,20 +101,7 @@
   "updateTime": 1602962783000,
   "valid": 1
 }
-新增:
-{
-  "objId": "OBJ_1",
-  "projectId": "PRJ_WD_001",
-  "itemCode": "1033",
-  "category": "消防报警",
-  "level": "S",
-  "remark": "测试数据",
-  "open": 1,
-  "concern": 1,
-  "userDefined": 1,
-  "valid": 1
-}
-更新(注:全量更新):
+更新:
 {
   "id": "1",
   "objId": "OBJ_1",
@@ -119,13 +115,9 @@
   "userDefined": 1,
   "valid": 1
 }
-删除:
-{
-  "id": "1"
-}
 ```
 
-####  报警记录
+####  报警记录(注:condition 为 query,create,update)
 
 请求路径:/alarm/record/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -155,20 +147,12 @@
   "remark": "测试数据",
   "valid": 1
 }
-更新(注:全量更新)
+更新:
 {
   "id": "1",
-  "itemCode": "1033",
-  "projectId": "PRJ_WD_001",
-  "objId": "OBJ_1",
-  "level": "S",
   "remark": "测试数据",
   "valid": 1
 }
-删除:
-{
-  "id": "1"
-}
 ```
 
 ####