Browse Source

添加服务依赖支持文档,查询 创建 删除

zhangweixin 4 years ago
parent
commit
24846c478d
3 changed files with 107 additions and 37 deletions
  1. 35 1
      docs/dev/lib/web/create.md
  2. 24 1
      docs/dev/lib/web/delete.md
  3. 48 35
      docs/dev/lib/web/query.md

+ 35 - 1
docs/dev/lib/web/create.md

@@ -1 +1,35 @@
-# 创建
+# 创建
+### 创建实体对象
+例如创建设备实体对象:
+```metadata json
+{
+  "Content": [
+    {
+      "ProjectId": "Pj1102290001",
+      "Category": "TDLS",
+      "EquipLocalID": "ATFU-TOP-N-003",
+      "EquipLocalName": "低压开关柜-A03"
+    }
+  ]
+}
+
+```
+返回结果
+```metadata json
+{
+  "EntityList": [
+    {
+      "Category": "TDLS",
+      "CodeType": 1,
+      "EquipID": "Eq1102290001e2a2b859d59347af99649f7d234384d0",
+      "EquipLocalID": "ATFU-TOP-N-003",
+      "EquipLocalName": "低压开关柜-A03",
+      "EquipName": "低压开关柜-W55EJ",
+      "ProjectId": "Pj1102290001"
+    }
+  ],
+  "Message": "",
+  "Result": "success"
+}
+```
+创建对象,采用可以单个对象创建,也可以批量创建多个对象,创建返回的结果中会把创建的对象有值得属性返回,例如设备的ID,自动生成的名字都会在返回的结果中

+ 24 - 1
docs/dev/lib/web/delete.md

@@ -1 +1,24 @@
-# 删除
+# 删除
+## 删除数据
+例如删除某一个设备
+```
+[
+    {
+        "EquipID":"Eq1102290001e2a2b859d59347af99649f7d234384d0"
+    },
+    {
+        "EquipID":"Eq1102290001e2a2b859d59347af99649f7d23789445"
+    }
+]
+```
+返回结果
+
+```metadata json
+{
+  "Message": "",
+  "Result": "success"
+}
+```
+
+如果删除失败, Message 中会返回失败原因,删除接口目前只支持根据主键删除,例如设备的主键为设备id 所以只要传入设备id即可
+如果需要根据某些条件删除,目前需要定制接口来解决,删除接口支持单个对象删除以及批量删除多个对象

+ 48 - 35
docs/dev/lib/web/query.md

@@ -97,7 +97,6 @@ PageSize 请求条数 Int 值 默认 50 条
 Filters 中编写过滤条件 例如:
 ```metadata json
 {
-  
   "Filters": "ProjectId = 'Pj3702020002'; Category = 'FSSN' ",
   "PageNumber": 1,
   "PageSize": 50
@@ -106,11 +105,9 @@ Filters 中编写过滤条件 例如:
 分号(;代表 and )还可以使用 and 来查询,例如:
 ```metadata json
 {
-  
   "Filters": "ProjectId = 'Pj3702020002' and Category = 'FSSN' ",
   "PageNumber": 1,
   "PageSize": 50
-  
 }
 
 ```
@@ -121,7 +118,6 @@ Orders 排序,默认升序 asc 可以多字段排序,升序 asc  降序 desc
 
 ```metadata json
 {
-  
   "Filters": "ProjectId = 'Pj3702020002' and Category = 'FSSN' ",
   "PageNumber": 1,
   "PageSize": 50,
@@ -177,7 +173,7 @@ Projection 指定后返回的属性,有些时候并不想把某些对象所有
 ```
 去重是不根据 Projection 指定返回的属性去重的,如果返回的字段中包含id,是无法去重的,因为id通常是唯一的,去重是根据指定返回的字段为一个从整体去重的。
 
-## 级联查询 (根据条件筛选、关系类型筛选级联) 
+## 级联查询 
 级联查询:在查询某一个对象的时候想要知道和这个对象有关系的有哪些对象,可以通过级联查询来操作,例如查询设备,以及所在的业务空间:
 请求体
 ```
@@ -251,7 +247,7 @@ ZoneSpaceBaseIn 中的数据就是当前设备所在的业务空间
 ```
 上面的例子是查询设备 ,设备坐在的业务空间,业务空间和系统的关系,返回结构和上面的类似,在空间的数据中会出现系统的实例数据
 
-## 综合示例 (多条件组合案例)
+## 综合示例 
 查询某一楼层下的低压开关柜设备,使用创建时间加设备 ID 排序升序,指定返回字段为 EquipID EquipName Category EquipLocalID EquipLocalName
 返回数量为100条 ,顺便查出来设备所在的默认业务空间,设备下的部件,设备关联的资产,设备和竖井的关系实例,竖井指定返回id和名称,示例如下:
 
@@ -271,7 +267,7 @@ ZoneSpaceBaseIn 中的数据就是当前设备所在的业务空间
      {
       "Name": "shaft",
         "Projection": [
-         "EquipID", "EquipName", "Category", "EquipLocalID", "EquipLocalName"
+         "ShaftID", "ShaftName"
          ]   
      }
   ],
@@ -288,36 +284,53 @@ ZoneSpaceBaseIn 中的数据就是当前设备所在的业务空间
 
 ```metadata json
 {
-  "Content": [
-    {
-      "Category": "TDLS",
-      "EquipID": "Eq11010200020321acc7e6f311e88ca4e5a21975b346",
-      "EquipLocalID": "ATFU-TOP-N",
-      "EquipLocalName": "楼顶北低压开关柜",
-      "EquipName": "低压开关柜-E5L73"
-      "ZoneSpaceBaseIn": [
+    "Content":[
         {
-          "BuildingId": "Bd110102000223fbec0accfb11e8a471b5d1be3b6dfe",
-          "FloorId": "Fl1101020002fbdcd07ed5cb11e88bee4dbb551fd992",
-          "LastUpdate": "2020-07-17 17:17:19",
-          "ObjectType": "GeneralZone",
-          "ProjectId": "Pj1101020002",
-          "RoomFuncType": "311",
-          "RoomID": "Sp11010200024fdbd800e0aa11e88bee13864ca4ba47",
-          "RoomLocalID": "7F-A801-1",
-          "RoomLocalName": "A-801室",
-          "RoomName": "空间-ISRWU",
-          "RoomQRCode": "2012bb68-2c9a-4bcc-a9a4-e0128634bf65"
+            "Category":"TDLS",
+            "EquipID":"Eq11010200020321acc7e6f311e88ca4e5a21975b346",
+            "EquipLocalID":"ATFU-TOP-N",
+            "EquipLocalName":"楼顶北低压开关柜",
+            "EquipName":"低压开关柜-E5L73",
+            "ZoneSpaceBaseIn":[
+                {
+                    "BuildingId":"Bd110102000223fbec0accfb11e8a471b5d1be3b6dfe",
+                    "FloorId":"Fl1101020002fbdcd07ed5cb11e88bee4dbb551fd992",
+                    "ObjectType":"GeneralZone",
+                    "ProjectId":"Pj1101020002",
+                    "RoomFuncType":"311",
+                    "RoomID":"Sp11010200024fdbd800e0aa11e88bee13864ca4ba47",
+                    "RoomLocalID":"7F-A801-1",
+                    "RoomLocalName":"A-801室",
+                    "RoomName":"空间-ISRWU",
+                }
+            ],
+            "component":[
+                {
+                    "Category":"TDLSDW",
+                    "EquipID":"Ec11010200020321acc7e6f311e88ca4e5a21975b303",
+                    "EquipLocalID":"ATFU-TOP-N-0",
+                    "EquipLocalName":"楼顶北低压开关柜抽屉"
+                }
+            ],
+            "property":{
+                "Category":"LSA",
+                "EquipID":"Pe11010200020321acc7e6f311e88ca4e5a21975b340",
+                "EquipLocalID":"ATFU-TOP-N",
+                "EquipLocalName":"楼顶北低压开关柜"
+            },
+            "shaftList":[
+                {
+                    "ShaftID":"Sh11010200020321acc7e6f311e88ca4e5a21975b349",
+                    "ShaftName":"楼梯间"
+                }
+            ]
         }
-      ],
-       "component"
-    }
-  ],
-  "Message": "",
-  "PageNumber": 1,
-  "PageSize": 50,
-  "Result": "success",
-  "Total": 1
+    ],
+    "Message":"",
+    "PageNumber":1,
+    "PageSize":50,
+    "Result":"success",
+    "Total":1
 }
 ```