yaoll 5 лет назад
Родитель
Сommit
146ffc0200
1 измененных файлов с 156 добавлено и 0 удалено
  1. 156 0
      物理世界接口文档.md

+ 156 - 0
物理世界接口文档.md

@@ -205,6 +205,162 @@ POST: /object/query
 }
 ```
 
+
+#### 基础接口: 查询图实例
+接口说明
+```
+目前图实例是内置数据,仅提供查询
+```
+请求地址
+```
+POST /graph/query
+```
+请求参数
+```
+{
+    "criteria": {
+        "graphType": "ArchSubset"
+    }
+}
+```
+返回内容
+```
+{
+  "result" : "success",
+  "data" : [ 
+      {
+        "id" : "GtArchSubset001",
+        "projectId" : "Pj3203020001",
+        "graphType" : "ArchSubset",
+        "sequenceId" : "001",
+        "valid" : true,
+        "createTime" : "20200519140942"
+      }
+  ]
+}
+
+```
+
+
+
+#### 基础接口: 创建关系
+接口说明
+```
+该接口是批量创建接口
+调用时需确保每一项的数据正确,如果有任意一个或多于一个元素存在错误则返回报错,同时参数正确的数据也不会保存
+同样的参数可以调用多次,如果参数对应的关系已存在则覆盖更新
+需要确保使用的graphId和rel是最新版字典定义的数据,接口会对graphId和rel进行校验(目前未校验)
+```
+请求地址
+```
+POST: /relation/save
+```
+请求参数
+```
+[ 
+    {
+      "graphId" : "ddd",
+      "rel" : "atob",
+      "from" : "Sp320302000147eab664592c4a818bc5aebf8ad88f91",
+      "to" : "Si3203020001e86cab26efdc11e9872a55fddb5ea8bb"
+    }, {
+      "graphId" : "ddd",
+      "rel" : "atob",
+      "from" : "Sp320302000147eab664592c4a818bc5aebf8ad88f91",
+      "to" : "Si32030200016f0b820a1a8c11eaac5ab725fa2ffefc"
+    } 
+]
+```
+返回内容
+```
+{
+  "result" : "fail",
+  "message" : "参数错误",
+  "data" : [ 
+      {
+        "result" : "success",
+        "target" : {
+          "graphId" : "ddd",
+          "rel" : "atob",
+          "from" : "Sp320302000147eab664592c4a818bc5aebf8ad88f91",
+          "to" : "Si3203020001e86cab26efdc11e9872a55fddb5ea8bb"
+        }
+      }, {
+        "result" : "error",
+        "target" : {
+          "graphId" : "ddd",
+          "rel" : "atob",
+          "from" : "Sp320302000147eab664592c4a818bc5aebf8ad88f91",
+          "to" : "abc"
+        },
+        "error" : "to对象Id[abc]不存在;"
+      } 
+  ]
+}
+```
+
+#### 基础接口: 删除关系
+接口说明
+```
+该接口是批量删除接口
+调用时需确保每一项的数据正确,如果有任意一个或多于一个元素存在错误则返回报错,同时参数正确的数据也不会处理
+根据入参删除一个或多个关系实例
+请务必明确入参逻辑
+```
+请求地址
+```
+POST /relation/delete
+```
+请求参数
+```
+[ 
+    {
+      "graphId" : "ddd",
+      "rel" : "atob",
+      "from" : "Sp320302000147eab664592c4a818bc5aebf8ad88f91"
+    }, 
+    {
+      "graphId" : "ddd",
+      "rel" : "atob",
+      "to" : "Si32030200016f0b820a1a8c11eaac5ab725fa2ffefc"
+    } 
+]
+
+```
+返回内容
+```
+{
+  "result" : "success",
+  "data" : [ 
+      {
+        "result" : "success",
+        "target" : {
+          "graphId" : "ddd",
+          "rel" : "atob",
+          "from" : "Sp320302000147eab664592c4a818bc5aebf8ad88f91"
+        },
+        "deletedCount" : 2
+      }, {
+        "result" : "success",
+        "target" : {
+          "graphId" : "ddd",
+          "rel" : "atob",
+          "to" : "Si32030200016f0b820a1a8c11eaac5ab725fa2ffefc"
+        },
+        "deletedCount" : 0
+      } 
+  ],
+  "totalDeletedCount" : 2
+}
+```
+返回内容说明
+| 字段名       | 数据类型 | 说明  |
+| ----------  | -------- | ------------------------- |
+| data.deletedCount   | Integer   | 单个参数对应删除的关系的数量 |
+| totalDeletedCount       | Integer   | 所有参数对应删除的关系的数量 |
+|             |          |                           |
+
+
 #### 基础接口: 查询关系
 
 接口说明