API:获取集成状态
GET https://api.bimface.com/integrate
调用方发起集成以后,可以通过该接口查询集成状态。
请求(Request)
Header
key |
value |
示例 |
Authorization |
bearer {accessToken} |
bearer xxxx-xxxx-xxxx-xxxx |
Content-Type |
application/json |
… |
Url Parameter
字段 |
类型 |
必填 |
描述 |
示例 |
integrateId |
Number |
Y |
集成id |
857482189666208 |
Request Body
无
curl -X GET
-H "Authorization: bearer <your accessToken>"
-H "Content-Type: application/json"
"https://api.bimface.com/integrate?integrateId=<your integrateId>"
响应(Response)
HTTP STATUS
200
成功返回
{
"code": "success",
"message": null,
"data": {
"integrateId": 85929027838566,
"name": "我的合并模型",
"status": "success",
"priority":2,
"thumbnail":[
"https://m.bimface.com/3305d7afabd9c7c0bf793e391bc3a068/thumbnail/96.png",
"https://m.bimface.com/3305d7afabd9c7c0bf793e391bc3a068/thumbnail/256.png"
],
"reason": null,
"createTime": "2015-08-08 12:23:11"
}
}
字段 |
类型 |
描述 |
示例 |
integrateId |
Number |
集成Id |
85929027838566 |
name |
String |
调用方设置的名称 |
我的合并模型 |
status |
String |
集成状态 |
processing(集成中)、success(集成成功)、failed(集成失败) |
priority |
Number |
优先级,数字越大,优先级越低 |
1, 2, 3 |
thumbnail |
String[] |
缩略图地址 |
… |
reason |
String |
若集成失败,返回失败原因 |
… |
createTime |
String |
集成开始时间,格式:yyyy-MM-dd hh:mm:ss |
2015-08-08 12:23:11 |
失败返回
{
"code": "authentication.failed",
"message": "Token was not recognized."
}
错误码
code |
说明 |
system.error |
BIMFACE系统异常 |
authentication.failed |
API访问合法性校验失败 |
integration.not.found |
找不到模型集成的记录 |