lijie 3 éve
szülő
commit
64ecaaf71b
1 módosított fájl, 558 hozzáadás és 2 törlés
  1. 558 2
      docs/rwd/rwd_api.md

+ 558 - 2
docs/rwd/rwd_api.md

@@ -812,7 +812,7 @@ POST请求
   "roomFuncType":"***",
   "keyword":"***",
   "page":1,
-  "pageSize":50
+  "size":50
 }
 ```
 
@@ -919,7 +919,7 @@ POST请求
   "classCode":"***",
   "keyword":"***",
   "page":1,
-  "pageSize":50
+  "size":50
 }
 ```
 
@@ -992,6 +992,562 @@ POST请求
 
 
 
+### 21012 按类型编码查询所有设备
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryEquipListByClassCode?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   |
+
+#### 参数例子
+
+```
+{
+  "classCode":"***",
+  "keyword":"***",
+  "page":1,
+  "size":50
+}
+```
+
+| 字段      | 是否必须 | 字段说明                                  |
+| --------- | -------- | ----------------------------------------- |
+| keyword   | 否       | 设备本地名称筛选关键字                    |
+| classCode | 是       | 设备类型,数据范围为专业/系统类/设备类code |
+| page      | 否       | 分页页数,从1开始                          |
+| pageSize  | 否       | 分页条数                                  |
+
+#### 成功例子
+
+```
+{
+    "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"
+        }
+    ],
+    "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    |        | 否       | 更新应用                                                     |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月23日15:44:33 | 新增 | 新增接口 |
+
+
+
+### 21013 按系统查询系统下所有设备
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryEquipListBySystemId?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   |
+
+#### 参数例子
+
+```
+{
+  "systemId":"***",
+  "keyword":"***",
+  "page":1,
+  "size":50
+}
+```
+
+| 字段     | 是否必须 | 字段说明               |
+| -------- | -------- | ---------------------- |
+| keyword  | 否       | 设备本地名称筛选关键字 |
+| systemId | 是       | 系统id                 |
+| page     | 否       | 分页页数,从1开始       |
+| pageSize | 否       | 分页条数               |
+
+#### 成功例子
+
+```
+{
+    "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"
+        }
+    ],
+    "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    |        | 否       | 更新应用                                                     |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月23日15:44:33 | 新增 | 新增接口 |
+
+
+
+### 21014 支持按指定[专业、系统、设备类、楼层、安装位置、生产厂家、设备状态、维保单位名称],模糊[设备名称、设备型号]查询设备列表,并按条件排序
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryEquipListBySystemId?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   |
+
+#### 参数例子
+
+```
+{
+  "classCode":"***",
+  "systemId":"***",
+  "floorId":"***",
+  "installLocation":"***",
+  "manufacturer":"***",
+  "equipStatus":"***",
+  "warranter":"***",
+  "keyword":"***",
+  "page":1,
+  "size":50
+}
+```
+
+| 字段            | 是否必须 | 字段说明               |
+| --------------- | -------- | ---------------------- |
+| classCode       | 否       | 专业编码               |
+| systemId        | 否       | 系统id                 |
+| floorId         | 否       | 楼层id                 |
+| installLocation | 否       | 安装位置               |
+| manufacturer    | 否       | 生产厂家               |
+| equipStatus     | 否       | 设备状态               |
+| warranter       | 否       | 维保单位名称           |
+| keyword         | 否       | 设备本地名称筛选关键字 |
+| systemId        | 是       | 系统id                 |
+| page            | 否       | 分页页数,从1开始       |
+| pageSize        | 否       | 分页条数               |
+
+#### 成功例子
+
+```
+{
+    "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"
+        }
+    ],
+    "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    |        | 否       | 更新应用                                                     |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月23日15:44:33 | 新增 | 新增接口 |
+
+
+
+### 21015 支持按指定空间功能类型查询此空间类型及其下级类型的所有空间列表
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/querySpaceListByRoomFuncType?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   |
+
+#### 参数例子
+
+```
+{
+  "roomFuncType":"***",
+  "keyword":"***",
+  "page":1,
+  "size":50
+}
+```
+
+| 字段         | 是否必须 | 字段说明               |
+| ------------ | -------- | ---------------------- |
+| keyword      | 否       | 空间本地名称筛选关键字 |
+| roomFuncType | 是       | 空间功能类型           |
+| page         | 否       | 分页页数,从1开始       |
+| pageSize     | 否       | 分页条数               |
+
+#### 成功例子
+
+```
+{
+    "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"
+        }
+    ],
+    "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/spaceInfoCodeView.md) |
+| virtualCodes |        | 否       | 虚点清单                                                     |
+| createApp    |        | 否       | 创建应用                                                     |
+| updateApp    |        | 否       | 更新应用                                                     |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月23日15:44:33 | 新增 | 新增接口 |
+
+
+
+### 21016 根据上级id查询下级关联对象
+
+> 本接口使用的关系仅涉及到建筑空间类-建筑空间类中的建筑从属关系,建筑空间类-机电精装类中的机电类所在区域关系,机电精装类-机电精装类中的机电从属关系.其他关系暂不涉及
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd/rwd/instance/object/queryObjectListSuperiorId?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   |
+
+#### 参数例子
+
+```
+{
+  "projectId":"***",
+  "buildingId":"***",
+  "floorId":"***",
+  "equipmentId":"***",
+  "classCodes":["***","****"],
+  "objTypes":["****","***"],
+  "keyword":"***",
+  "page":1,
+  "size":50,
+  "onlyCount":false,
+  "createTimeScope":{
+  	"startEq":"yyyyMMddHHmmss",
+  	"endEq":"yyyyMMddHHmmss"
+  },
+  "returnInfos":["***","****"],
+  "validSet":[]
+}
+```
+
+| 字段            |         | 是否必须 | 字段说明                                        |
+| --------------- | ------- | -------- | ----------------------------------------------- |
+| projectId       |         | 否       | 项目id                                          |
+| buildingId      |         | 否       | 建筑id                                          |
+| floorId         |         | 否       | 楼层id                                          |
+| equipmentId     |         | 否       | 设备id                                          |
+| classCodes      |         | 否       | 对象类型编码集合                                |
+| objTypes        |         | 否       | 对象分类编码集合                                |
+| keyword         |         | 否       | 本地名称筛选关键字                              |
+| page            |         | 否       | 分页页数,从1开始                                |
+| size            |         | 否       | 分页条数                                        |
+| onlyCount       |         | 否       | 是否值返回数量                                  |
+| createTimeScope |         | 否       | 创建时间筛选范围                                |
+|                 | startEq | 否       | 大于等于                                        |
+|                 | endEq   | 否       | 小于等于                                        |
+| returnInfos     |         | 否       | 返回信息点,仅过滤infos里的信息点,基本属性不过滤 |
+| validSet        |         | 否       | 有效范围过滤                                    |
+
+#### 成功例子
+
+```
+{
+    "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"
+        }
+    ],
+    "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    |        | 否       | 更新应用                                                     |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月23日15:44:33 | 新增 | 新增接口 |
+
 
 
 ## 对象关系接口