Browse Source

Merge remote-tracking branch 'origin/master'

wudla 4 năm trước cách đây
mục cha
commit
067cce7b7e

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

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

+ 1 - 1
docs/rwd/def_class.md

@@ -48,7 +48,7 @@
 请求方式
 请求方式
 
 
 ```
 ```
-POST /def/class?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id&subFlag=false
+POST /rwd/def/class?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id&subFlag=false
 ```
 ```
 
 
 路径参数说明
 路径参数说明

+ 1 - 1
docs/rwd/def_funcid.md

@@ -86,7 +86,7 @@ Tree、Topology、Route、Function四种类型不再支持(有需求再加回来
 请求方式
 请求方式
 
 
 ```
 ```
-POST /def/funcid?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/def/funcid?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
 ```
 ```
 
 
 路径参数说明
 路径参数说明

+ 40 - 36
docs/rwd/instance_object.md

@@ -31,8 +31,8 @@
 接口说明
 接口说明
 
 
 ```
 ```
-1.项目ID不可为空
-2.appId不可为空(目前未校验)
+1.集团编码,项目id,appId,userId不可为空
+2.
 3.该接口为批量接口,任一对象创建失败则全部失败
 3.该接口为批量接口,任一对象创建失败则全部失败
 
 
 ```
 ```
@@ -40,24 +40,25 @@
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/object/create?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/object/create
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明     |
-| --------- | -------- | -------- |
-| groupCode | String   | 集团编码 |
-| schemeId  | String   | 方案 id  |
-| projectId | String   | 项目 id  |
-| appId     | String   | 应用 id  |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 
 ```
 ```
 [
 [
     {
     {
-        "id": "对象id, 调用方传入,若为空则生成默认id,目前默认id为uuid",
+        "id": "对象id, 调用方传入,若为空则生成默认id",
         "classCode": "类型编码,不可为空",
         "classCode": "类型编码,不可为空",
         "信息点编码": "信息点值"
         "信息点编码": "信息点值"
     }
     }
@@ -79,8 +80,8 @@ POST /instance/object/create?groupCode=集团编码&schemeId=方案id&projectId=
 接口说明
 接口说明
 
 
 ```
 ```
-1.项目ID不可为空
-2.appId不可为空(目前未校验)
+1.集团编码,项目id,appId,userId不可为空
+2.
 3.该接口为批量接口,任一对象更新失败则全部失败
 3.该接口为批量接口,任一对象更新失败则全部失败
 4.classCode不可修改
 4.classCode不可修改
 
 
@@ -89,17 +90,18 @@ POST /instance/object/create?groupCode=集团编码&schemeId=方案id&projectId=
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/object/update?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/object/update
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明     |
-| --------- | -------- | -------- |
-| groupCode | String   | 集团编码 |
-| schemeId  | String   | 方案 id  |
-| projectId | String   | 项目 id  |
-| appId     | String   | 应用 id  |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 
@@ -107,7 +109,8 @@ POST /instance/object/update?groupCode=集团编码&schemeId=方案id&projectId=
 [
 [
     {
     {
         "id": "对象id, 调用方传入,若为空则生成默认id,目前默认id为uuid",
         "id": "对象id, 调用方传入,若为空则生成默认id,目前默认id为uuid",
-        "信息点编码": "信息点值"
+        "信息点编码": "信息点值",
+        "$remove": [ "要清除的信息点编码" ]
     }
     }
 ]
 ]
 
 
@@ -127,8 +130,8 @@ POST /instance/object/update?groupCode=集团编码&schemeId=方案id&projectId=
 接口说明
 接口说明
 
 
 ```
 ```
-1.项目ID不可为空
-2.appId不可为空(目前未校验)
+1.集团编码,项目id,appId,userId不可为空
+2.
 3.该接口为批量接口
 3.该接口为批量接口
 4.对象删除后与该对象相关的关系数据也会被删除(异步,未实现)
 4.对象删除后与该对象相关的关系数据也会被删除(异步,未实现)
 
 
@@ -137,17 +140,18 @@ POST /instance/object/update?groupCode=集团编码&schemeId=方案id&projectId=
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/object/delete?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/object/delete
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明     |
-| --------- | -------- | -------- |
-| groupCode | String   | 集团编码 |
-| schemeId  | String   | 方案 id  |
-| projectId | String   | 项目 id  |
-| appId     | String   | 应用 id  |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 
@@ -169,17 +173,17 @@ POST /instance/object/delete?groupCode=集团编码&schemeId=方案id&projectId=
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/object/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/object/query
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明     |
-| --------- | -------- | -------- |
-| groupCode | String   | 集团编码 |
-| schemeId  | String   | 方案 id  |
-| projectId | String   | 项目 id  |
-| appId     | String   | 应用 id  |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id            |
 
 
 请求体
 请求体
 
 

+ 31 - 27
docs/rwd/instance_relation.md

@@ -36,12 +36,13 @@ POST /instance/relation/create?groupCode=集团编码&schemeId=方案id&projectI
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码          |
-| schemeId  | String   | 方案 id           |
-| projectId | String   | 项目 id, 不可为空 |
-| appId     | String   | 应用 id           |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 
@@ -80,17 +81,18 @@ POST /instance/relation/create?groupCode=集团编码&schemeId=方案id&projectI
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/relation/delete?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/relation/delete?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码          |
-| schemeId  | String   | 方案 id           |
-| projectId | String   | 项目 id, 不可为空 |
-| appId     | String   | 应用 id           |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 
@@ -121,17 +123,18 @@ POST /instance/relation/delete?groupCode=集团编码&schemeId=方案id&projectI
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/relation/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/relation/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码          |
-| schemeId  | String   | 方案 id           |
-| projectId | String   | 项目 id, 不可为空 |
-| appId     | String   | 应用 id           |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 
@@ -186,17 +189,18 @@ POST /instance/relation/query?groupCode=集团编码&schemeId=方案id&projectId
 请求方式
 请求方式
 
 
 ```
 ```
-POST /instance/relation/object/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
+POST /rwd/instance/relation/object/query?groupCode=集团编码&schemeId=方案id&projectId=项目id&appId=应用id
 ```
 ```
 
 
 路径参数说明
 路径参数说明
 
 
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码          |
-| schemeId  | String   | 方案 id           |
-| projectId | String   | 项目 id, 不可为空 |
-| appId     | String   | 应用 id           |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| schemeId  | String   | 方案 id            |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
+| userId    | String   | 用户 id, 不可为空  |
 
 
 请求体
 请求体
 
 

+ 8 - 8
docs/rwd/iot.md

@@ -2,11 +2,11 @@
 
 
 以下参数放在 url 后
 以下参数放在 url 后
 
 
-| 字段      | 数据类型 | 说明              |
-| --------- | -------- | ----------------- |
-| groupCode | String   | 集团编码          |
-| projectId | String   | 项目 id, 不可为空 |
-| appId     | String   | 应用 id           |
+| 字段      | 数据类型 | 说明               |
+| --------- | -------- | ------------------ |
+| groupCode | String   | 集团编码, 不可为空 |
+| projectId | String   | 项目 id, 不可为空  |
+| appId     | String   | 应用 id, 不可为空  |
 
 
 ### 基础接口: 查询实时数据
 ### 基础接口: 查询实时数据
 
 
@@ -19,7 +19,7 @@
 请求地址
 请求地址
 
 
 ```
 ```
-POST: /iot/data/current
+POST: /rwd/iot/data/current
 ```
 ```
 
 
 请求参数
 请求参数
@@ -85,7 +85,7 @@ POST: /iot/data/current
 请求地址
 请求地址
 
 
 ```
 ```
-POST: /iot/data/history
+POST: /rwd/iot/data/history
 ```
 ```
 
 
 请求参数
 请求参数
@@ -175,7 +175,7 @@ POST: /iot/data/history
 请求地址
 请求地址
 
 
 ```
 ```
-POST: /iot/funcid/setting
+POST: /rwd/iot/funcid/setting
 ```
 ```
 
 
 请求参数
 请求参数