API:获取模型对比状态
GET https://api.bimface.com/compare
应用发起对比以后,可以通过该接口查询对比状态。
请求(Request)
Header
key |
value |
示例 |
Authorization |
bearer {accessToken} |
bearer xxxx-xxxx-xxxx-xxxx |
Content-Type |
application/json |
… |
Url Parameter
字段 |
类型 |
必填 |
描述 |
示例 |
compareId |
Number |
Y |
模型对比ID |
857482189666208 |
Request Body
无
curl -X GET
-H "Authorization: bearer <your accessToken>"
-H "Content-Type: application/json"
"https://api.bimface.com/compare?compareId=<your compareId>"
响应(Response)
HTTP STATUS
200
成功返回
{
"code": "success",
"message": null,
"data": {
"compareId": 85929027838566,
"status": "processing",
"priority":2,
"thumbnail":null,
"reason": null,
"createTime": "2015-08-08 12:23:11"
}
}
字段 |
类型 |
描述 |
示例 |
compareId |
Number |
对比ID |
85929027838566 |
status |
String |
对比状态 |
prepare(待对比)、processing(对比中)、success(对比成功)、failed(对比失败) |
priority |
Number |
对比任务优先级 |
2 |
reason |
String |
若对比失败,返回对比原因 |
… |
createTime |
String |
对比开始时间,格式:yyyy-MM-dd hh:mm:ss |
2016-10-14 14:29:16 |
失败返回
{
"code": "authentication.failed",
"message": "Token was not recognized."
}
错误码
code |
说明 |
system.error |
BIMFACE系统异常 |
authentication.failed |
API访问合法性校验失败 |
file.not.found |
文件不存在 |