Browse Source

新增部分接口

lijie 3 years ago
parent
commit
71aa8be04b
1 changed files with 340 additions and 3 deletions
  1. 340 3
      docs/rwd/rwd_api.md

+ 340 - 3
docs/rwd/rwd_api.md

@@ -1568,6 +1568,139 @@ POST请求
 
 
 
+### 21017 根据图类型编码及关系类型编码查询对象及其关联对象
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryObjectListByGraphCodeAndRelCode?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 是       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+{
+  "relCode":"***",
+  "graphCode":"***",
+  "relValue":"***",
+  "mainContent":"***",
+  "fromContent":["****","***"],
+  "page":1,
+  "size":50
+}
+```
+
+| 字段        |      | 是否必须 | 字段说明                                                     |
+| ----------- | ---- | -------- | ------------------------------------------------------------ |
+| relCode     |      | 是       | 关系类型编码                                                 |
+| graphCode   |      | 是       | 图类型编码                                                   |
+| relValue    |      | 否       | 关系值,一般空间关系会有,为空间的对象类型                     |
+| mainContent |      | 否       | 主对象的筛选关键字,筛选范围为id,name,local_id,local_name,cADID |
+| fromContent |      | 否       | 从对象的筛选关键字.objTo对应的对象,筛选范围为id,name,local_id,local_name |
+| page        |      | 否       | 分页页数,从1开始                                             |
+| size        |      | 否       | 分页条数                                                     |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data":[
+        {
+            "id": "Pj1100002633",
+            "valid": 1,
+            "creationTime": 1628733867000,
+            "creator": "0",
+            "modifiedTime": null,
+            "modifier": null,
+            "projectId": "Pj1100002633",
+            "name": "asdasd",
+            "localId": "asdasd",
+            "localName": "asdasd",
+            "objType": "project",
+            "classCode": "project",
+            "groupCode": "YL",
+            "grouping": 1,
+            "infos": {
+            },
+            "virtualCodes": [],
+            "createApp": "dmp",
+            "updateApp": "dmp",
+            "relObjs":[
+                {
+                	"id": "Pj1100002633",
+                    "valid": 1,
+                    "creationTime": 1628733867000,
+                    "creator": "0",
+                    "modifiedTime": null,
+                    "modifier": null,
+                    "projectId": "Pj1100002633",
+                    "name": "asdasd",
+                    "localId": "asdasd",
+                    "localName": "asdasd",
+                    "objType": "project",
+                    "classCode": "project",
+                    "groupCode": "YL",
+                    "grouping": 1,
+                    "infos": {
+                    }
+                }
+			]
+        }
+    ],
+    "count": 20
+}
+```
+
+| 字段         | 子字段 | 是否必须 | 字段说明                                                     |
+| ------------ | ------ | -------- | ------------------------------------------------------------ |
+| id           |        | 是       | Pj+6位地区码+4位顺序码                                       |
+| valid        |        | 否       | 合法标识,0-无效,1-有效                                       |
+| creationTime |        | 否       | 创建时间,时间戳                                              |
+| creator      |        | 否       | 创建人账号id                                                 |
+| modifiedTime |        | 否       | 最后更新时间,时间戳                                          |
+| modifier     |        | 否       | 最后更新人id                                                 |
+| projectId    |        | 是       | 所属项目id                                                   |
+| name         |        | 是       | 项目名称                                                     |
+| localId      |        | 否       | 项目本地编码                                                 |
+| localName    |        | 否       | 项目本地名称                                                 |
+| objType      |        | 是       | 对象类型,见[对象类型](/utils/common.md)                      |
+| classCode    |        | 否       | 对象类型编码,见接口26001查询结果中的code值                   |
+| groupCode    |        | 是       | 集团编码                                                     |
+| grouping     |        | 是       | 1单个对象,2对象组                                            |
+| infos        |        | 否       | 对象信息点对象,见[设备信息点说明](/utils/equipmentInfoCodeView.md) |
+| virtualCodes |        | 否       | 虚点清单                                                     |
+| createApp    |        | 否       | 创建应用                                                     |
+| updateApp    |        | 否       | 更新应用                                                     |
+| objFromIds   |        | 否       | 关联的对象id,楼层对象为建筑id,空间对象为建筑id和楼层id,设备对象为设备id,系统对象为系统id |
+| objToIds     |        | 否       | 关联的对象id,楼层对象为楼层id,空间对象为空间id,设备对象为建筑id,系统对象为建筑id |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容                      |
+| --------------------- | ---- | ----------------------------- |
+| 2021年8月23日15:44:33 | 新增 | 新增接口                      |
+| 2021年8月26日14:38:27 | 修改 | 返回值新增objFromIds,objToIds |
+
+
+
 ## 对象关系接口
 
 ### 22001 查询物理世界对象关系(Deprecated)
@@ -1846,7 +1979,7 @@ POST请求
 
 
 
-### 22004 根据对象id和关系查询对象列表
+### 22004 根据对象id和关系查询对象列表(暂未实现)
 
 #### 接口
 
@@ -1936,8 +2069,6 @@ POST请求
 
 
 
-
-
 ## 图类型接口
 
 ### 23001 查询图类型(Deprecated)
@@ -4723,3 +4854,209 @@ POST请求
 | --------------------- | ---- | -------- |
 | 2021年8月17日00:11:42 | 新增 | 新增接口 |
 
+
+
+## 关系计算接口
+
+> 本类接口为兼容ADM而生,待业务梳理清楚后再决定是否保留
+
+### 29001 根据id,localId,name,localName,CADID及关系类型信息,对象分类信息创建关系
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/compatible/createObjRelationsByKeywordAndObjType?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 是       | 集团编码 |
+| projectId | 是       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+{
+    "graphCode":"****",
+	"relCode":"****",
+	"masterObjType":"***",
+	"slaveObjType":"***",
+	"type":"***",
+	"hasRelValue":true,
+	"hasFilterClassCode":true,
+	"hasCheckSensor":true,
+	"hasCheckClassCode":true,
+	"checkClassCodes":["***","***"],
+	"checkSensorCodes":["***","***"],
+	"sign":"1",
+	"mainContent":"***",
+	"fromContent":["***"]
+}
+```
+
+| 字段               | 是否必须 | 字段说明                                                     |
+| ------------------ | -------- | ------------------------------------------------------------ |
+| graphCode          | 是       | 图类型编码                                                   |
+| relCode            | 是       | 边类型编码                                                   |
+| masterObjType      | 是       | 主对象类型                                                   |
+| slaveObjType       | 是       | 从对象类型                                                   |
+| type               | 是       | 编码类型,CADID图纸编码(cadId),设备名称(name),设备ID(id),本地编码(localId),本地名称(localName) |
+| mainContent        | 是       | 主对象内容                                                   |
+| fromContent        | 是       | 从对象内容                                                   |
+| sign               | 否       | 计算标记 1 为手动 2为自动                                    |
+| hasRelValue        | 否       | 创建关系时是否带上relValue,默认不赋值                        |
+| hasFilterClassCode | 否       | 查询从对象时是否过滤classCode,true-过滤,false-不过滤,默认不过滤 |
+| hasCheckSensor     | 否       | 是否检查传感器类型,true-检查,false-不检查,默认不检查.        |
+| hasCheckClassCode  | 否       | 是否检查classCode,true-检查,false-不检查,默认不检查          |
+| checkClassCodes    | 否       | 是否检查classCode使用的classCodes列表                        |
+| checkSensorCodes   | 否       | 是否检查传感器使用的传感器类型列表                           |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id":"***",
+            "graphCode": "图类型编码",
+            "graphId": "图类型Id",
+            "relCode": "边类型编码",
+            "objFrom": "",
+            "objTo": "",
+            "valid":1,
+            "creator":"创建人账号id",
+            "creationTime":"创建时间,格式为yyyyMMddHHmmss",
+            "modifiedTime":"最后更新时间,格式为yyyyMMddHHmmss",
+            "modifier":"最后更新账号id"
+        }
+    ]
+}
+```
+
+| 字段         | 是否必有 | 字段说明                          |
+| ------------ | -------- | --------------------------------- |
+| id           | 是       | 32位UUID                          |
+| groupCode    | 否       | 集团编码                          |
+| projectId    | 是       | 项目id                            |
+| graphId      | 否       | 图主键                            |
+| graphCode    | 否       | 图编码                            |
+| relCode      | 否       | 关系编码                          |
+| objFrom      | 否       | 来源对象id                        |
+| objTo        | 否       | 目标对象id                        |
+| valid        | 是       | 合法标识,1-有效,0-无效            |
+| creator      | 否       | 创建人账号id                      |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss     |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss |
+| modifier     | 否       | 最后更新账号id                    |
+
+#### 接口修改记录
+
+| 操作时间             | 操作 | 操作内容 |
+| -------------------- | ---- | -------- |
+| 2021年9月2日20:56:41 | 新增 | 新增接口 |
+
+
+
+### 29002 根据fromId,toId,relType,graphCode删除关系
+
+> 不用删除关系接口是因为这个接口还得处理一下计算的业务
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/compatible/deleteObjRelationsByRelId?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 是       | 集团编码 |
+| projectId | 是       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+{
+    "graphCode":"****",
+	"relCode":"****",
+	"objFrom":"***",
+	"objTo":"***"
+}
+```
+
+| 字段      | 是否必须 | 字段说明   |
+| --------- | -------- | ---------- |
+| graphCode | 是       | 图类型编码 |
+| relCode   | 是       | 边类型编码 |
+| objFrom   | 是       | 来源对象   |
+| objTo     | 是       | 去向对象   |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": [
+        {
+            "id":"***",
+            "graphCode": "图类型编码",
+            "graphId": "图类型Id",
+            "relCode": "边类型编码",
+            "objFrom": "",
+            "objTo": "",
+            "valid":1,
+            "creator":"创建人账号id",
+            "creationTime":"创建时间,格式为yyyyMMddHHmmss",
+            "modifiedTime":"最后更新时间,格式为yyyyMMddHHmmss",
+            "modifier":"最后更新账号id"
+        }
+    ]
+}
+```
+
+| 字段         | 是否必有 | 字段说明                          |
+| ------------ | -------- | --------------------------------- |
+| id           | 是       | 32位UUID                          |
+| groupCode    | 否       | 集团编码                          |
+| projectId    | 是       | 项目id                            |
+| graphId      | 否       | 图主键                            |
+| graphCode    | 否       | 图编码                            |
+| relCode      | 否       | 关系编码                          |
+| objFrom      | 否       | 来源对象id                        |
+| objTo        | 否       | 目标对象id                        |
+| valid        | 是       | 合法标识,1-有效,0-无效            |
+| creator      | 否       | 创建人账号id                      |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss     |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss |
+| modifier     | 否       | 最后更新账号id                    |
+
+#### 接口修改记录
+
+| 操作时间             | 操作 | 操作内容 |
+| -------------------- | ---- | -------- |
+| 2021年9月2日20:56:41 | 新增 | 新增接口 |
+