|
@@ -0,0 +1,533 @@
|
|
|
+# 管理说明书缺失接口文档:
|
|
|
+
|
|
|
+## 1. 楼层列表查询(楼层数据)
|
|
|
+
|
|
|
+注:zkt-monitor 接口修改:增加返回值,工程信息化/data/plaza/floor接口的gcname字段
|
|
|
+
|
|
|
+## 2. 楼层简介查询(楼层功能)
|
|
|
+
|
|
|
+注:zkt-monitor接口修改:增加返回值,层高和面积
|
|
|
+
|
|
|
+## 3. 查询楼层基本信息及楼层下的设备空间数量统计(作用范围:楼层功能 - 单层,设备设施模块 )
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/count?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ "queryType":0, //必传,0-楼层功能模块 1-设备设施模块
|
|
|
+ “systemCode”:"****" //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "buildArea":“****”, //建筑面积㎡ -楼层面积:area ?
|
|
|
+ "leaseArea":”****“, //租赁面积㎡-leaseArea
|
|
|
+ “storeNum”:****, //商铺数量 -自定义信息点
|
|
|
+ “motorVehicleNum”:****, //机动车车位 -自定义信息点
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "className":"***", //类型名称
|
|
|
+ "objNum":***, //设备数量
|
|
|
+ "systemCode":***, //系统编码
|
|
|
+ “bimTypeId":"***" //BIM构建编码
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+ 注:排序规则:优先按数字是否为0排序,然后按类型名称首字母排序
|
|
|
+
|
|
|
+## 4. 根据类型查询对象信息(楼层功能 - 单层 )
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/query?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ "queryType":0, //必传,0-楼层功能模块 1-设备设施模块(只统计阀门,设备)
|
|
|
+ “systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ ”bimTypeId“:["****"] //BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “systemCode”:"****", //所属系统编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:equipment-设备,space-空间,material-阀门
|
|
|
+ “classCode”:"***" //类型编码
|
|
|
+ "location":{ //对象所在位置
|
|
|
+ “floor”:[
|
|
|
+ {
|
|
|
+ "id":"Fl****", //楼层id
|
|
|
+ “localName”:“F1”, //楼层名称
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "space":[
|
|
|
+ {
|
|
|
+ "id":"Sp****", //空间id
|
|
|
+ "localName":"空间#1", //空间名称
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ...
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+注:具体信息点编码参考中台数据字典定义
|
|
|
+
|
|
|
+## 5. 修改楼层基本信息及统计数量(设备设施(通用)-全局,设备设施(通用)-单层)-暂时不做
|
|
|
+
|
|
|
+注:楼层简介中的建筑面积修改后,清理zkt-monitor 中 redis 14号索引库的缓存
|
|
|
+
|
|
|
+## 6. 通过空间id查询空间详情 (设备设施(通用)-单空间)
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/queryInfo?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “id”:"****", //空间id
|
|
|
+ “objType”:"space" //对象类型,查询空间时默认space
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:equipment-设备,space-空间,material-阀门
|
|
|
+ “classCode”:"***" //类型编码
|
|
|
+ ... //其它信息点参考中台数据字典
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 7. 统计空间内的设备和阀门个数(设备设施(通用)-单空间)
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/rel/count?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ “systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ ”bimTypeId“:"****" //空间的BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ “bimTypeId”:"***", //BIM构建编码,设备/阀门类型的唯一编码
|
|
|
+ “className”:"***", //类型名称
|
|
|
+ “systemCode”:"***", //所属系统编码
|
|
|
+ "count":8, //对象数量
|
|
|
+ “objects”:[ //设备
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:equipment-设备,material-阀门
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 8. 查询设备设施-供电系统-全局-楼层电井
|
|
|
+
|
|
|
+注:zkt-sdk接口已实现,需增加返回电表号字段 - 后续新增信息点
|
|
|
+
|
|
|
+## 9. 查询设备设施- 暖通系统-全局-3D原理图相关的设备/阀门
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/havcSystem/query?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ //“systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ //”bimTypeId“:"****" //空间的BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ “bimTypeId”:"***", //BIM构建编码,设备/阀门类型的唯一编码
|
|
|
+ “className”:"***", //类型名称
|
|
|
+ “systemCode”:"***", //所属系统编码
|
|
|
+ "count":8, //对象数量
|
|
|
+ “objects”:[ //设备
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:equipment-设备,material-阀门
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+注:查询冷却塔设备类下的设备,制冷机房空间下的设备/阀门信息,所属系统编码,所在空间
|
|
|
+
|
|
|
+## 10. 设备设施-暖通系统-分集水器原理图查询
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/subCatchment/query?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ //“systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ //”bimTypeId“:"****" //空间的BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ “bimTypeId”:"***", //BIM构建编码,设备/阀门类型的唯一编码
|
|
|
+ “className”:"***", //类型名称
|
|
|
+ “systemCode”:"***", //所属系统编码
|
|
|
+ "count":8, //对象数量
|
|
|
+ “objects”:[ //设备
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:equipment-设备,material-阀门
|
|
|
+ ]
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+注:查询分水器、集水器类型下的对象信息,对象信息需要增加所属系统编码
|
|
|
+
|
|
|
+## 11. 防火分区数量统计
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/fireZone/count?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ //“systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ //”bimTypeId“:"****" //空间的BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ “bimLocalId”:"****", //防火分区bimID
|
|
|
+ "fireZoneName":"***", //防火分区
|
|
|
+ "hostNumber":"***", //主机编号
|
|
|
+ "loopNumber":"***", //回路编号
|
|
|
+ "smokeNum": ***, //烟感数量
|
|
|
+ "warmNum": ***, //温感数量
|
|
|
+ "handNum": ***, //手报数量
|
|
|
+ "hydrantsNum": ***, //消火栓数量
|
|
|
+ "moldNum": *** //模块数量
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+注:统计各消防分区下的空间数量,关联的主机编号,烟感数量,温感数量等。
|
|
|
+
|
|
|
+## 12. 查询各防火分区下的空间信息(防火分区界面:3D图展示用)
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/fireZone/query?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ //“systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ ”bimTypeId“:["****"] //空间的BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:space-空间
|
|
|
+ “classCode”:"***" //类型编码
|
|
|
+ ... //其它信息点参考中台数据字典
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+注:查询各防火分区下的空间信息
|
|
|
+
|
|
|
+## 13. 主要材料查询(设备设施-土建装饰-全局)
|
|
|
+
|
|
|
+注:确认来源,数据是否来自于工程信息化
|
|
|
+
|
|
|
+## 14. 查询土建装饰设备设施说明
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/construction/query?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ //“systemCode”:"****", //系统编码(非必传,可根据系统筛选,不传时查所有)
|
|
|
+ //”bimTypeId“:"****" //空间的BIM构建编码(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "floorId":"****", //楼层id
|
|
|
+ "remark":"***" //说明
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 15. 添加土建装饰设备设施说明
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/construction/add?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ "remark":"***" //说明(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "floorId":"****", //楼层id
|
|
|
+ "remark":"***" //说明
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 16. 修改土建装饰设备设施说明
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/construction/update?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+ "remark":"***" //说明(必传)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "floorId":"****", //楼层id
|
|
|
+ "remark":"***" //说明
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 17. 删除土建装饰设备实施说明
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/construction/delete?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "floorId":"****", //楼层id
|
|
|
+ "remark":"***" //说明
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+## 18. 根据楼层获取地板对象
|
|
|
+
|
|
|
+接口名称:http://<ip>:<port>/object/floorBoard/query?groupCode=集团编码&projectId=项目id
|
|
|
+
|
|
|
+请求参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ “buildId”:"****", //建筑id(非必传,楼层ID为空时,必传)
|
|
|
+ "floorId":"****", //楼层id (非必传,不传查全楼)
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+返回参数:
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result":"success"
|
|
|
+ "count":12,
|
|
|
+ "content":[
|
|
|
+ {
|
|
|
+ "id":“****”, //id
|
|
|
+ "name":”****“, //名称
|
|
|
+ “localId”:****, //本地编码
|
|
|
+ “localName”:****, //本地名称(展示时使用此名称)
|
|
|
+ “bimId":"***", //bimID
|
|
|
+ "bimLocation":"-178.1,126.3,225.9", //bim坐标
|
|
|
+ “bimTypeId”:"***", //BIM构建编码
|
|
|
+ “outLine”:[{"x":123.2,"y":210,"z":227.9}], //轮廓坐标
|
|
|
+ “objType”:"***", //对象类型:space-空间
|
|
|
+ “classCode”:"***" //类型编码
|
|
|
+ ... //其它信息点参考中台数据字典
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+
|