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

添加报表统计接口文档

fengyanjie@sagacloud.cn 4 éve
szülő
commit
bba196db02

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

@@ -10,7 +10,8 @@ module.exports = {
             { text: '人员组织权限', link: '/org/' },
             { text: '数据标准化', link: '/dic/'},
             { text: '任务调度', link: '/task/' },
-            { text: '报警系统', link: '/alarm/'}
+            { text: '报警系统', link: '/alarm/'},
+            { text: '报表统计系统', link: '/report/'}
             ],
 
         sidebarDepth: 2,
@@ -25,6 +26,16 @@ module.exports = {
                     ]
                 }
             ],
+            '/report': [
+                {
+                    title: '报表统计系统',
+                    collapsable: false,
+                    children: [
+                        {title: '接口文档', path: '/report/report_api'},
+                        {title: '数据结构设计', path: '/report/report_design'}
+                    ]
+                }
+            ],
             '/alarm': [
                 {
                     title: '报警系统',

+ 8 - 0
docs/report/index.md

@@ -0,0 +1,8 @@
+## 报表统计系统
+
+#### [接口文档](/report/report_api.md)
+
+#### [数据结构设计](/alarm/report_design.md)
+
+
+

+ 80 - 0
docs/report/report_api.md

@@ -0,0 +1,80 @@
+# 报表统计接口文档
+
+#### 查询
+
+[通用查询](/utils/query.md)
+
+### 查询对象报警数量
+
+请求路径:POST /report/alarm/record/query?projectId=项目Id
+
+请求参数:
+
+```json
+查询字段:
+{
+    "criteria": {
+        "itemCode": "报警条目编码,非必填",
+        "projectId": "项目Id,非必填",
+        "category": "报警类型,取值范围:Eq,Sy,非必填",
+        "objId": "对象Id,非必填",
+        "classCode": "对象类型编码,非必填",
+        "level": "严重程度,非必填",
+        "state": 2,//报警状态,非必填
+        "createTime": "报警创建时间,格式:yyyyMMdd,非必填"
+    }
+}
+```
+返回数据:
+
+```json
+{
+    "result": "success",
+    "data": [
+        {
+            "id": 1,
+            "itemCode": "1010",
+            "projectId": "Pj1101050029",
+            "category": "Eq",
+            "objId": "Eq1101050029707953e99dc146bcbe8230d46b39cb1f",
+            "classCode": "ACATFC",
+            "level": "A",
+            "state": 2,
+            "createTime": "20201103",
+            "count": 75 //报警数量
+        }
+    ],
+    "count": 1
+}
+```
+
+### 根据设备类型查询设备数量
+
+请求路径:POST /report/rwd/object/queryCountByClass?projectId=项目Id
+
+请求参数:
+
+```json
+查询字段:
+{
+    "classCode":"ACATAH"//设备类型,非必填
+}
+```
+
+返回数据:
+
+```json
+{
+    "result": "success",
+    "data": {
+        "data": [
+            {
+                "projectId": "Pj1101050029", //项目Id
+                "objType": "equipment", //对象分类
+                "classCode": "ACATAH",//设备类型
+                "count": 162 //设备数量
+            }
+        ]
+    }
+}
+```

+ 18 - 0
docs/report/report_ddl_sql.md

@@ -0,0 +1,18 @@
+# 报警信息报表 report_alarm_record
+
+```sql
+CREATE TABLE `report_alarm_record` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT '主键',
+  `item_code` varchar(40) NOT NULL COMMENT '报警条目编码',
+  `project_id` varchar(50) NOT NULL DEFAULT '' COMMENT '项目id',
+  `category` varchar(80) NOT NULL COMMENT '报警分类',
+  `obj_id` varchar(50) NOT NULL DEFAULT '' COMMENT '对象id',
+  `class_code` varchar(50) NOT NULL COMMENT '对象类型编码',
+  `level` varchar(10) NOT NULL COMMENT '严重程度',
+  `state` int NOT NULL COMMENT '报警状态',
+  `create_time` varchar(8) NOT NULL COMMENT '创建时间',
+  `count` int DEFAULT '0' COMMENT '数量',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB AUTO_INCREMENT=4096 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='报警信息报表';
+
+```

+ 18 - 0
docs/report/report_design.md

@@ -0,0 +1,18 @@
+# 报表统计系统
+
+## 数据结构
+
+### 报警信息报表(report_alarm_record)
+
+|   字段    |      字段说明      |   数据类型   | 是否非空 |           备注           |
+| :-------: | :----------------: | :----------: | -------- | :----------------------: |
+|    id     | 主键(无业务含义) | int(11)  | Y        | 全局唯一,自增无实际意义 |
+|   item_code    |    报警条目编码    | varchar(80)  | Y        |                          |
+|   project_id    |    项目id    | varchar(50)  | Y        |                          |
+| category  |      报警分类      | varchar(80) |          |                          |
+|   obj_id   |      对象id      | varchar(50)  |          |                          |
+| class_code  |      对象类型编码      |   varchar(50)   | Y        |                          |
+| level |      严重程度      |     varchar(10)     |          |                          |
+|   state   |      报警状态      | int  | Y        |      1:true,0:false      |
+|  create_time   |      创建时间      | varchar(8) |          |                          |
+|  count   |      数量      | int |          |                          |

A különbségek nem kerülnek megjelenítésre, a fájl túl nagy
+ 10788 - 0
package-lock.json