# 发起净空分析

POST https://api.bimface.com/feature-management/v1/spaces/clearance-height-check

# 说明

模型需要包含空间信息,基于已有空间信息才可进行净空分析。空间信息来源:模型包含、用户创建、BIMFACE识别

# 参数

Authorization * Bearer {accessToken} string
*为必填项
# Body
integrateId * 集成ID(fileId和integrateId选填一项) int64
fileId * 文件ID(fileId和integrateId选填一项) int64
checkList * 净空分析检查条件设置列表 < SpaceCheckItem >array
spaceIdList * 对应空间id列表 < string >array
selection 选择集 ObjectSelection
objectData 构件筛选条件,key-value形式 < Map«string,string» >array
objectIds 构件id列表 < string >array
option 净空分析选项 Option
targetHeight * 目标高度 double
unit 设置高度单位,可选m、mm string
minIgnoreHeight 最小忽略高度,不考虑对此高度及以下的构件执行分析 double
maxIgnoreHeight 最大忽略高度,不考虑对此高度及以上的构件执行分析 double
name 净空分析名称,长度不超过128个字符 string
callback 回调url string
description 记录用户需要的标记信息,用于对该净高分析进行说明,长度不超过256个字符 string

# 响应

HTTP代码 说明 类型
200 OK GeneralResponseV1«ClearanceResponse»
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -
# 200响应参数
GeneralResponseV1«ClearanceResponse»
名称 说明 类型
code 样例: "code" string
data 返回数据 ClearanceResponse
reason 失败原因 string
clearanceHeightId 净空分析ID int64
createTime 创建时间 int64
errorCode 错误码 string
status 任务状态 string
message 提示消息 string

# 消耗

  • application/json

# 生成

  • */*
  • application/json

# HTTP请求示例

# 请求 path
https://api.bimface.com/feature-management/v1/spaces/clearance-height-check
# 请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
# 请求 body
{
    "fileId":10000026830491,
    "name":"官方revit模型测试净空分析",
    "description":"官方revit模型测试净空分析,净高2.7m",
    "checkList":[
        {
            "spaceIdList":['573789'],
            "option":{
                "targetHeight":"2500",
                "minIgnoreHeight":"1800",
                "unit":"mm"
            }
        }
    ]
}

# HTTP响应示例

# 响应 200
{
    "code": "bimfaceservice-0000",
    "message": null,
    "data": {
        "clearanceHeightId": 2548945837050624,
        "cost": null,
        "createTime": "2023-01-05T07:39:17.000Z",
        "databagVersion": null,
        "errorCode": null,
        "fileVersion": null,
        "reason": null,
        "status": "processing"
    }
}