查询离线数据包_文档_BIMFACE_BIM应用二次开发平台

API:查询离线数据包

通过传入相应的ID查询对应离线数据包

文件转换ID:GET  https://api.bimface.com/files/{fileId}/offlineDatabag
集成模型ID:GET  https://api.bimface.com/integrations/{integrateId}/offlineDatabag
模型对比ID:GET  https://api.bimface.com/comparisions/{compareId}/offlineDatabag

根据fileId、integrateId、compareId查询离线数据包信息。


请求(Request)

Header
key value 示例
Authorization bearer {accessToken} bearer xxxx-xxxx-xxxx-xxxx
Content-Type application/json
Url Parameter
字段 类型 必填 描述 示例
fileId Number Y 通过文件转换ID查询离线数据包时必填 1199714943746080
integrateId Number Y 通过集成模型ID查询离线数据包时必填 1299714943746080
compareId Number Y 通过模型对比ID查询离线数据包时必填 1309714943746080
Request Body

curl -X GET 
-H "Authorization: bearer <your accessToken>" 
-H "Content-Type: application/json" 
"https://api.bimface.com/files/{your fileId}/offlineDatabag
 https://api.bimface.com/integrations/{your integrateId}/offlineDatabag
 https://api.bimface.com/comparisions/{your compareId}/offlineDatabag"

响应(Response)

HTTP STATUS

200

成功返回
{  
    "code": "success",
    "message": "",
    "data": [{
        "fileId": 8167234891,      
        "databagVersion": "2.0",   
        "status": "processing",       
        "reason": null,
        "createTime":"2017-10-17 09:21:59"
    }]
}

字段 类型 描述 示例
fileId Long 文件转换Id 8167234891
databagVersion String 离线包版本 2.0
status String 离线包状态 processing(生成中)、success(生成成功)、failed(生成失败)
reason String 若生成失败,返回失败原因
createTime String 离线包生成时间 2017-10-17 09:21:59
失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明
system.error BIMFACE系统异常
authentication.failed API访问合法性校验失败
offline.databag.not.found 离线数据包未找到