Parcourir la source

更新 'docs/report/report_api.md'

fengyanjie il y a 4 ans
Parent
commit
d19064bc93
1 fichiers modifiés avec 60 ajouts et 50 suppressions
  1. 60 50
      docs/report/report_api.md

+ 60 - 50
docs/report/report_api.md

@@ -6,23 +6,65 @@
 
 ### 查询对象报警数量
 
-请求路径:POST /report/alarm/record/query?projectId=项目Id
+请求路径:POST /report/query?projectId=Pj1101050029&dateType=SEASON
+
+参数说明:
+
+```
+projectId:项目id
+dateType:日期类型
+```
+
+计算方式取值范围:
+
+```
+	/**
+	 * 求和
+	 */
+	SUM,
+	/**
+	 * 求平均
+	 */
+	AVG,
+	/**
+	 * 求最大值
+	 */
+	MAX,
+	/**
+	 * 求最小值
+	 */
+	MIN,
+	/**
+	 * 求数量
+	 */
+	COUNT
+```
 
 请求参数:
 
 ```json
 查询字段:
 {
+    "groupbyColumns": [
+        "分组字段"
+    ],
     "criteria": {
-        "itemCode": "报警条目编码,非必填",
-        "projectId": "项目Id,非必填",
-        "category": "报警类型,取值范围:Eq,Sy,非必填",
-        "objId": "对象Id,非必填",
-        "classCode": "对象类型编码,非必填",
-        "level": "严重程度,非必填",
-        "state": 2,//报警状态,非必填
-        "createTime": "报警创建时间,格式:yyyyMMdd,非必填"
-    }
+        "字段名":"字段值,每个报表的字段都不同,详情参考‘数据结构’文件"
+    },
+    "orders": [
+        {
+            "column": "排序字段",
+            "asc": false
+        }
+    ],
+    "calculatedColumns": [
+        {
+            "column": "计算列名称",
+            "function": "计算方式,参考上方‘计算方式取值范围’"
+        }
+    ],
+    "page": 1,
+    "size": 10
 }
 ```
 返回数据:
@@ -32,49 +74,17 @@
     "result": "success",
     "data": [
         {
-            "id": 1,
-            "itemCode": "1010",
-            "projectId": "Pj1101050029",
-            "category": "Eq",
-            "objId": "Eq1101050029707953e99dc146bcbe8230d46b39cb1f",
+            "calculatedColumns": [
+                {
+                    "column": "alarmRecordNum",
+                    "function": "SUM",
+                    "value": 0
+                }
+            ],
             "classCode": "ACATFC",
-            "level": "A",
-            "state": 2,
-            "createTime": "20201103",
-            "count": 75 //报警数量
+            "dateType": "YEAR"
         }
     ],
     "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 //设备数量
-            }
-        ]
-    }
-}
 ```