Browse Source

新增接口

lijie 3 years ago
parent
commit
422f717ca1
2 changed files with 144 additions and 1 deletions
  1. 124 0
      docs/rwd/rwd_api.md
  2. 20 1
      docs/utils/common.md

+ 124 - 0
docs/rwd/rwd_api.md

@@ -443,6 +443,128 @@ POST请求
 
 
 
+### 21008 根据项目id批量查询项目信息
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/batchQueryProjectByIds?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   |
+
+#### 参数例子
+
+```
+["***","***"]
+```
+
+| 字段 | 是否必须 | 字段说明 |
+| ---- | -------- | -------- |
+| ***  | 是       | 对象id   |
+
+#### 成功例子
+
+```
+{
+    "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": {
+                "city": "810300",
+                "altitude": 1,
+                "latitude": 1,
+                "province": "810000",
+                "longitude": 1,
+                "projIntro": "asdfasdfasf",
+                "urbanZone": "810309",
+                "climateZone": "00",
+                "projFuncType": "M00",
+                "urbanDevpLev": "0000",
+                "groupManageZone": "4b950e729d914607919045be0bf91151",
+                "businessOpeningTime": "20210814"
+            },
+            "virtualCodes": [],
+            "createApp": "dmp",
+            "updateApp": null
+        }
+    ],
+    "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        |                     | 否       | 对象信息点对象                             |
+|              | city                | 否       | 城市编码                                   |
+|              | altitude            | 否       | 海拔                                       |
+|              | latitude            | 否       | 纬度                                       |
+|              | province            | 否       | 省编码                                     |
+|              | longitude           | 否       | 经度                                       |
+|              | projIntro           | 否       | 项目简介                                   |
+|              | urbanZone           | 否       | 区域编码                                   |
+|              | climateZone         | 否       | 气候区编码                                 |
+|              | projFuncType        | 否       | 项目功能类型编码                           |
+|              | urbanDevpLev        | 否       | 城市发展水平                               |
+|              | groupManageZone     | 否       | 管理分区id                                 |
+|              | businessOpeningTime | 否       | 项目开业时间,格式yyyyMMdd                  |
+| virtualCodes |                     | 否       | 虚点清单                                   |
+| createApp    |                     | 否       | 创建应用                                   |
+| updateApp    |                     | 否       | 更新应用                                   |
+
+
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月16日11:28:07 | 新增 | 新增接口 |
+
+
+
 ### 21007 删除物理世界对象数据-批量删除(Deprecated)
 
 #### 接口
@@ -494,6 +616,8 @@ POST请求
 
 
 
+## 对象关系接口
+
 ### 22001 查询物理世界对象关系(Deprecated)
 
 #### 接口

+ 20 - 1
docs/utils/common.md

@@ -540,4 +540,23 @@ withColumns 粒度比较粗,一般由服务提供者决定哪些字段可以通
 | calendar_tag                    | 日历标签           |
 | calendar_interval               | 日历时间段         |
 | consumable_all                  | 耗材编码           |
-| tool_all                        | 工具编码           |
+| tool_all                        | 工具编码           |
+
+
+
+## 对象类型(对应objType字段)
+
+| 编码      | 说明     |
+| --------- | -------- |
+| project   | 项目     |
+| building  | 楼       |
+| floor     | 楼层     |
+| space     | 空间     |
+| system    | 系统     |
+| equipment | 设备     |
+| shaft     | 竖井     |
+| component | 部件     |
+| virtual   | 虚拟对象 |
+| tool      | 工具     |
+| material  | 耗材     |
+