wudla 4 роки тому
батько
коміт
e3343aaf5a

+ 2 - 1
docs/.vuepress/config.js

@@ -9,7 +9,8 @@ module.exports = {
             { text: '物理世界', link: '/rwd/' },
             { text: '人员组织权限', link: '/org/' },
             { text: '数据标准化', link: '/dic/'},
-            { text: '任务调度', link: '/dpt/' }
+            { text: '任务调度', link: '/dpt/' },
+            { text: '报警系统', link: '/alarm/'}
             ],
 
         sidebarDepth: 1,

+ 36 - 0
docs/alarm/alarm.ddl.sql

@@ -0,0 +1,36 @@
+## 报警系统数据表
+
+# 报警条目表
+
+DROP TABLE IF EXISTS `alarm_item`;
+
+CREATE TABLE alarm_item (
+    id varchar(40) NOT NULL PRIMARY KEY COMMENT '',
+    code varchar(40) NOT NULL COMMENT '报警条目编码(6位数字)',
+    name varchar(255) NULL COMMENT '报警条目名称',
+    project_id varchar(40) NULL COMMENT '项目ID',
+    alarm_category varchar(100) NULL COMMENT '报警分类',
+    level varchar(40) NULL COMMENT '严重程度 S A B C D 五级',
+    valid int NULL COMMENT '有效状态',
+    create_user varchar(40) NULL COMMENT '创建用户',
+    create_time timestamp NULL COMMENT '创建时间',
+    update_user varchar(40) NULL COMMENT '更新用户',
+    update_time timestamp NULL COMMENT '更新时间',
+    remark varchar(500) NULL COMMENT '备注'
+) COMMENT '报警条目表';
+
+# 报警记录表
+
+DROP TABLE IF EXISTS `alarm_record`;
+
+CREATE TABLE alarm_record (
+    id varchar(40) NOT NULL PRIMARY KEY,
+    code varchar(40) NULL COMMENT '报警条目编码',
+    project_id varchar(50) NULL COMMENT '项目id',
+    object_id varchar(50) NULL COMMENT '对象id',
+    level varchar(10) NULL COMMENT '严重程度 S A B C D 五级',
+    status varchar(50) NULL COMMENT '状态',
+    create_time varchar(14) NULL COMMENT '创建时间',
+    recover_time varchar(14) NULL COMMENT '恢复时间',
+    remark varchar(500) NULL COMMENT '备注'
+) COMMENT '报警记录表';

+ 174 - 0
docs/alarm/alarm_api.md

@@ -0,0 +1,174 @@
+# 报警系统接口文档
+
+## 系统接口
+
+#### 查询
+
+[通用查询](http://git.sagacloud.cn/persagy/persagy-dmp-doc/src/master/api_document/通用查询.md)
+
+#### 报警条目
+
+请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "code": "1033",
+  "name": "测试报警",
+  "category": "消防报警",
+  "level": "S",
+  "remark": "测试数据",
+  "dealFun": "test_deal_fun",
+  "createUser": "test",
+  "createTime": 1602962584000,
+  "updateUser": "test",
+  "updateTime": 1602962586000,
+  "valid": 1
+}
+```
+
+#### 报警匹配规则
+
+请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "itemCode": "1033",
+  "classCode": "OBJ_AX_CODE",
+  "createUser": "test",
+  "createTime": 1602963135000,
+  "updateUser": "test",
+  "updateTime": 1602963138000,
+  "valid": 1
+}
+新增:
+{
+  "itemCode": "1033",
+  "classCode": "OBJ_AX_CODE",
+  "valid": 1
+}
+更新:
+{
+  "id": "1",
+  "itemCode": "1033",
+  "classCode": "OBJ_AX_CODE",
+  "valid": 1
+}
+删除:
+{
+  "id": "1"
+}
+```
+
+#### 报警定义
+
+请求路径:/alarm/config/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "objId": "OBJ_1",
+  "projectId": "PRJ_WD_001",
+  "itemCode": "1033",
+  "category": "消防报警",
+  "level": "S",
+  "remark": "测试数据",
+  "open": 1,
+  "concern": 1,
+  "userDefined": 1,
+  "createUser": "test",
+  "createTime": 1602962781000,
+  "updateUser": "test",
+  "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",
+  "projectId": "PRJ_WD_001",
+  "itemCode": "1033",
+  "category": "消防报警",
+  "level": "S",
+  "remark": "测试数据",
+  "open": 1,
+  "concern": 1,
+  "userDefined": 1,
+  "valid": 1
+}
+删除:
+{
+  "id": "1"
+}
+```
+
+####  报警记录
+
+请求路径:/alarm/record/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数:
+
+```json
+查询字段:
+{
+  "id": "1",
+  "itemCode": "1033",
+  "projectId": "PRJ_WD_001",
+  "objId": "OBJ_1",
+  "level": "S",
+  "remark": "测试数据",
+  "createUser": "test",
+  "createTime": 1602953249000,
+  "updateUser": "test",
+  "updateTime": 1602953256000,
+  "valid": 1
+}
+新增:
+{
+  "itemCode": "1033",
+  "projectId": "PRJ_WD_001",
+  "objId": "OBJ_1",
+  "level": "S",
+  "remark": "测试数据",
+  "valid": 1
+}
+更新(注:全量更新):
+{
+  "id": "1",
+  "itemCode": "1033",
+  "projectId": "PRJ_WD_001",
+  "objId": "OBJ_1",
+  "level": "S",
+  "remark": "测试数据",
+  "valid": 1
+}
+删除:
+{
+  "id": "1"
+}
+```
+
+#### 

+ 73 - 0
docs/alarm/alarm_ddl_sql.md

@@ -0,0 +1,73 @@
+# 报警条目 alarm_item
+
+```sql
+CREATE TABLE alarm_item(
+    id VARCHAR(40) NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    code VARCHAR(40)    COMMENT '报警条目编码' ,
+    name VARCHAR(10)    COMMENT '报警条目名称' ,
+    category VARCHAR(10)    COMMENT '报警分类' ,
+    level VARCHAR(10)    COMMENT '严重程度' ,
+    remark TEXT    COMMENT '备注' ,
+    condition TEXT    COMMENT '触发条件' ,
+    deal_fun VARCHAR(40)    COMMENT '处理算法' ,
+  	create_user VARCHAR(40) COMMENT '',
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警条目';
+```
+
+# 报警条目匹配对象 alarm_target
+
+```sql
+CREATE TABLE alarm_target(
+    id VARCHAR(40)  NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    item_id VARCHAR(40)    COMMENT '报警条目id' ,
+    class_code VARCHAR(40)    COMMENT '对象类型' ,
+    condition TEXT    COMMENT '触发条件' ,
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警条目匹配对象';
+```
+
+# 报警定义 alarm_config
+
+```sql
+CREATE TABLE alarm_config(
+    id VARCHAR(40) NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    obj_id VARCHAR(50)    COMMENT '对象id' ,
+    project_id VARCHAR(50)    COMMENT '项目id' ,
+    item_code VARCHAR(40)    COMMENT '报警条目编码' ,
+    category VARCHAR(10)    COMMENT '报警分类' ,
+    level VARCHAR(10)    COMMENT '严重程度' ,
+    remark TEXT    COMMENT '备注' ,
+    condition TEXT    COMMENT '触发条件' ,
+    open INT    COMMENT '屏蔽状态' ,
+    concern INT    COMMENT '是否重点关注' ,
+    user_defined INT    COMMENT '是否自定义' ,
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警定义';
+```
+
+# 报警记录 alarm_record
+
+```sql
+CREATE TABLE alarm_record(
+    id VARCHAR(40)  NOT NULL AUTO_INCREMENT  COMMENT '主键' ,
+    item_code VARCHAR(40)    COMMENT '报警条目编码' ,
+    project_id VARCHAR(40)    COMMENT '项目id' ,
+    obj_id VARCHAR(40)    COMMENT '对象id' ,
+    level VARCHAR(10)    COMMENT '严重程度' ,
+    remark TEXT    COMMENT '报警描述' ,
+    create_time DATETIME    COMMENT '创建时间' ,
+    update_time DATETIME    COMMENT '更新时间' ,
+    valid INT NOT NULL  DEFAULT 1 COMMENT '删除标记 1:true,0:false' ,
+    PRIMARY KEY (id)
+) COMMENT = '报警记录';
+```

+ 7 - 0
docs/alarm/index.md

@@ -0,0 +1,7 @@
+## 数据标准化
+
+#### [接口文档](/alarm/alarm_api.md)
+
+
+
+

+ 1 - 1
docs/dpt/dpt_api.md

@@ -71,7 +71,7 @@
 }
 ```
 
-#### 更新(全量更新)
+#### 更新
 
 请求方法:POST
 

+ 0 - 127
docs/org/org_api.md

@@ -12,133 +12,6 @@
 
 ### 查询(请参考[通用查询](/utils/query.md))
 
-### 新增
-
-请求地址
-
-```text
-/example/create
-```
-
-请求参数
-
-```json
-{
-    "id": "1",
-    "name": "test",
-    "age": "23"
-}
-```
-
-返回结果:
-
-正确JSON示例
-
-```json
-{
-    "result": "success",
-    "message": null,
-    "data": {
-        "id": "1"
-    }
-}
-```
-
-错误JSON示例
-
-```json
-{
-    "result": "success",
-    "message": "错误信息,如果接口发生错误会返回该字段"
-}
-```
-
-
-
-### 更新
-
-请求地址
-
-```json
-POST: /example/update
-```
-
-请求参数
-
-```json
-{
-    "id": "1",
-    "name": "test",
-    "age": "23"
-}
-```
-
-返回结果:
-
-正确JSON示例
-
-```json
-{
-    "result": "success",
-    "message": null,
-    "data": {
-        "id": "123456"
-    }
-}
-```
-
-错误JSON示例
-
-```json
-{
-    "result": "success",
-    "message": "错误信息,如果接口发生错误会返回该字段"
-}
-```
-
-
-
-### 删除
-
-请求地址
-
-```json
-POST: /example/delete
-```
-
-请求参数
-
-```json
-{
-    "id": "1"
-}
-```
-
-返回结果:
-
-正确JSON示例
-
-```json
-{
-    "result": "success",
-    "message": null,
-    "data": {
-        "id": "1"
-    }
-}
-```
-
-错误JSON示例
-
-```json
-{
-    "result": "success",
-    "message": "错误信息,如果接口发生错误会返回该字段"
-}
-```
-
-### 
-
 ## 系统接口
 
 ### (注:condition 为 query,create,update,delete)