1. 查询指定构件周边范围内的房间列表
根据构件key的辐射范围获取构件所在的房间列表。
请求方式:POST
请求地址:/api/{databaseKey}/space/query/rooms/byComponentRange
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
无参数 | NULL | NULL | NULL | NULL |
Body
application/json:
{
"component": "构件key",
"r": "辐射半径,单位mm",
"type": "辐射类型(球或平面,参数可选ball或face)",
"cover": "是否完全覆盖(true或false)"
}
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
component | string | NULL | 否 | 构件key |
r | int | 500mm | 否 | 辐射半径,单位mm |
type | Boolean | ball | 否 | 辐射类型(球或平面,参数可选ball或face) |
cover | Boolean | true或false | 否 | 是否完全覆盖(true或false) |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": [
{
"key": "xxx", //房间Key
"name": "xxx", //房间名称
"maxBoundary": [xx,xx,xx
], //最大边界
"minBoundary": [xx,xx,xx
], // 最小边界
"floor":"" //所在楼层key
},
... ...
]
}
1.4. 状态码
状态码 | code | message | data | 原因 |
---|---|---|---|---|
400 | BAD_PARAMETER_VALUE | 构件(message)不存在 | NULL | 当component不存在时 |
1.5. 备注
仅支持IFC和RVT模型。
1.6. 注意事项
1、数据库启用gacl时,有模型关联的BOSF文档读取权限的用户。
2、数据库未启用gacl时,有数据库访问权限的用户。
1.7. Demo示例:
示例名称 | 示例地址 |
---|---|
查询指定构件周边范围内的房间列表 | 去体验 |