应用访问凭证获取

BIMFACE所有的RESTful API都有对应的鉴权机制保护,目前BIMFACE支持两种鉴权方式:

Access token

代表自身应用的身份,使用应用的appkey, secret,通过调用/oauth2/token接口获取。

View token

代表对单个模型/集成模型/模型对比的访问权限,使用access token,通过调用/view/token或其他相关接口获得。

使用Access token,可以对自己应用内的文件发起文件上传,下载,删除,模型转换,模型集成,模型对比等操作, 同时也能访问所有BIMFACE的数据接口获取转换后的模型BIM信息;而View token只代表对单个模型/集成模型/模型对比的临时的访问凭证, 只能访问对应模型的数据接口,通过使用应用的Access token调用下面的接口可以获得。 通常情况下,View token可以直接传入前端JSSDK用来加载/浏览模型

Access token有效期为7天, 除非token内注销,Access token在7天内不会发生改变; 而View token只是一个临时的访问凭证,有效期为12小时。但是为了减少用户重复请求View token的次数, 每次使用View token都会重置有效期为12小时。这样如果你的模型持续有人访问,View token会一直有效, 只有在12小时内,没有使用View token的任何调用,View token才会失效。
Access token只能使用appkey, secret通过/oauth2/token接口获取; 类似的,View token必须通过有效的Access token并提供对应的源文件Id以及集成模型Id信息来获取。
View token的使用方法是在调用对应的数据接口的时候,添加一个查询参数(Query parameter):
view_token={your_view_token}
只有在文件转换或模型集成任务成功以后,才能获取View token。

获取Access Token

POST https://api.bimface.com/oauth2/token
说明

在调用其他API之前,必须先获取Access Token。Access Token的有效期为7天

参数
类型 名称 说明 类型

Header

Authorization
可选

将字符串 appKey:appSecret 拼接后(中间用冒号连接),对其进行BASE64编码, 然后在编码后的字符串前添加字符串Basic和一个空格, 即:“Basic” + “ ” + Base64Encode(appKey + “:” + appSecret)

string

Query

credential
可选

credential

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/oauth2/token
请求 header
"Basic aVlhcEQ0aFQ5eUNQS2trbDdsYjdiaDlXcjJpY2V6VVE6c1VJejZPdng4b2xkNzVwUGxIeXhEUHY0c0FHa3RRbHQ="
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "expireTime" : "2018-11-21 18:33:44",
    "token" : "ab00e0b4-0db0-4554-a7a7-b6a274588816"
  },
  "message" : ""
}

获取模型的View token

GET https://api.bimface.com/view/token
说明

通过fileId, integrateId, compareId 获取View token, 然后把View token传入前端JavaScript组件提供的接口中,即可加载和浏览文件所包含的三维模型或二维图纸。

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

compareId
可选

通过模型对比ID获取ViewToken

integer (int64)

Query

fileId
可选

通过文件转换ID获取ViewToken

integer (int64)

Query

integrateId
可选

通过集成模型ID获取ViewToken

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/view/token
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}
响应 200
{
    "code": "success",
    "message": null,
    "data": "389c28de59ee62e66a7d87ec12692a76"
}
字段 类型 描述 示例

data

String

viewToken

389c28de59ee62e66a7d87ec12692a76

失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

file.has.not.translated

文件未转换,不能获取viewToken

file.translate.failed

文件转换失败,不能获取viewToken

file.is.translating

文件转换中,不能获取viewToken

integration.not.found

集成模型不存在,不能获取viewToken

files.is.integrating

集成中,不能获取viewToken

files.integrate.failed

集成失败,不能获取viewToken

model.compare.not.found

对比模型不存在,不能获取viewToken

model.compare.not.finished

对比未完成,不能获取viewToken

model.compare.failed

对比失败,不能获取viewToken

获取子文件的View Token

POST https://api.bimface.com/data/v2/integrations/{integrateId}/files/{fileId}/viewToken
说明

一般使用在获取不随着模型集成而集成的模型信息,如图纸,视图等

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

文件ID

integer (int64)

Path

integrateId
必填

集成ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1365349517067680/files/1365343983297376/viewToken
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

源文件相关

在注册成为BIMFACE的应用开发者后,要能在浏览器里浏览你的模型或者获取你模型内的BIM数据, 你需要首先把你的模型文件上传上来。根据不同场景,BIMFACE提供了丰富的文件相关的接口。

文件相关所有接口都需要提供有效的Access token。不支持View token。

源文件上传

普通文件流上传

PUT https://file.bimface.com/upload
说明

使用普通文件流上传

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Header

Content-Length
必填

数据流文件长度

integer (int64)

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/upload?name=3F.rvt
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
"Content-Length: 11672"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  },
  "message" : ""
}

指定外部文件url方式上传

PUT https://file.bimface.com/upload
说明

如果需要上传的文件不在本地,且该文件可以通过指定的HTTP URL可以下载,BIMFACE支持直接传一个外部的HTTP文件URL, BIMFACE会去下载该文件,而无须用户先下载,再上传。

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

etag
可选

文件etag

string

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

Query

url
必填

文件所在url

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/upload?name=example.rvt&url=http(s)://xxxxxxxxxxx
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  },
  "message" : ""
}

文件直传

BIMFACE使用了分布式对象存储来存储用户上传的模型/图纸文件。如使用普通的文件上传接口, 文件流会通过BIMFACE的服务器,再流向最终的分布式存储系统,整个上传过程会受BIMFACE服务器的带宽限制,上传速度非最优。 如使用文件直传接口,开发者应用在申请到一个Policy凭证后,可以直接上传文件跟BIMFACE后台的分布式存储系统, 这样上传速度和稳定性都会有提升,是我们推荐的上传方式。

另外,很多BIMFACE应用都有自己的Web前端页面,如果在前端JS代码里直接使用普通的文件上传接口会暴露Access token, 有安全性风险,这种情况我们也推荐使用文件直传接口。

文件直传的逻辑图如下:

web policy upload
使用流程如下:
  1. 开发者应用向BIMFACE申请上传Policy请求

  2. BIMFACE返回上传Policy和签名给开发者应用。

  3. 开发者应用使用在第二个步骤中获取的URL信息,直接上传文件数据到BIMFACE后端的分布式对象存储。

获取文件直传的policy凭证

GET https://file.bimface.com/upload/policy
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/upload/policy?name=example.rvt
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "accessId" : "QLYNXu7B9OTjErYR",
    "callbackBody" : "eyJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24veC13d3ctZm9ybS11cmxlbmNvZGVkIiwiY2FsbGJhY2tIb3N0IjoiZmlsZS5iaW1mYWNlLmNvbSIsImNhbGxiYWNrVXJsIjoiaHR0cHM6Ly8xMTYuMjI4LjE5NS4xOC9vc3MvcmVjZWl2ZSIsImNhbGxiYWNrQm9keSI6Im9iamVjdD0ke29iamVjdH0mc2l6ZT0ke3NpemV9JmV0YWc9JHtldGFnfSZuYW1lPXRlc3QucGRmJmZpbGVJZD0xNDgzMDY1NTc0NzU0NTI4JmFwcGtleT1hRGxQZjEzVXRpR3M3eXVIQ2Q4ZUhTTEhiSEpUVThTZCZzb3VyY2VJZD0mZmlsZUJ1Y2tldD1iZi1kZXYtc3JjZmlsZSJ9",
    "expire" : 1542792319,
    "host" : "https://bf-dev-srcfile.oss-cn-shanghai.aliyuncs.com",
    "objectKey" : "2f15df1c430b4ad3b0644029111b703a",
    "policy" : "eyJleHBpcmF0aW9uIjoiMjAxOC0xMS0yMVQwOToyNToxOS45OTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXV19",
    "signature" : "q4NrZ1By/msuHOHlgpgX56mMUhY=",
    "sourceId" : "b5046ca25c2748d2922757e749f3df61"
  },
  "message" : ""
}

断点续传

当文件比较大,或者所在网络网速较慢的情况下,单个文件上传的时间会比较长。如果中间有任何的网络错误, 本次上传就会被中断,那么文件就会需要重新上传,非常浪费时间。

为解决这个问题,BIMFACE提供了断点上传的接口,开发者可以利用这些接口对文件进行上传,即使上传过程种出现错误, 下一次也可以从上次错误的文件位置开始继续上传。

使用流程如下:
  1. 发送请求,申请创建一个追加文件,并记录该追加文件ID

  2. 每次上传前,使用该文件ID查询当前上传到的具体位置信息。

  3. 本地文件读取定位到在2)里获取的位置,调用追加上传接口,继续上传文件

创建追加文件

POST https://file.bimface.com/appendFiles
说明

进行断点续传前,先创建追加文件

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

length
必填

上传文件长度

integer (int64)

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/appendFiles?length=5353522&name=A4.rvt
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appendFileId" : 1216113551663296,
    "createTime" : "2017-11-09 13:25:03",
    "file" : {
      "createTime" : "2017-11-09 13:25:03",
      "etag" : "19349858cjs98ericu989",
      "fileId" : 1216113551663296,
      "length" : 39044,
      "name" : "-1F.rvt",
      "status" : "success",
      "suffix" : "rvt"
    },
    "length" : 39044,
    "name" : "-1F.rvt",
    "position" : 0,
    "status" : "success"
  },
  "message" : ""
}

查询追加文件信息

GET https://file.bimface.com/appendFiles/{appendFileId}
说明

根据appendFileId查询追加文件信息

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

appendFileId
必填

追加文件id

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/appendFiles/1216113551663296
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appendFileId" : 1216113551663296,
    "createTime" : "2017-11-09 13:25:03",
    "file" : {
      "createTime" : "2017-11-09 13:25:03",
      "etag" : "19349858cjs98ericu989",
      "fileId" : 1216113551663296,
      "length" : 39044,
      "name" : "-1F.rvt",
      "status" : "success",
      "suffix" : "rvt"
    },
    "length" : 39044,
    "name" : "-1F.rvt",
    "position" : 0,
    "status" : "success"
  },
  "message" : ""
}

追加文件信息

POST https://file.bimface.com/appendFiles/{appendFileId}/data
说明

根据创建的追加文件信息进行追加上传

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Path

appendFileId
可选

追加文件id

integer (int64)

Query

position
可选

追加上传开始位置

integer (int64)

0

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/appendFiles/123456789/data
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appendFileId" : 1216113551663296,
    "createTime" : "2017-11-09 13:25:03",
    "file" : {
      "createTime" : "2017-11-09 13:25:03",
      "etag" : "19349858cjs98ericu989",
      "fileId" : 1216113551663296,
      "length" : 39044,
      "name" : "-1F.rvt",
      "status" : "success",
      "suffix" : "rvt"
    },
    "length" : 39044,
    "name" : "-1F.rvt",
    "position" : 0,
    "status" : "success"
  },
  "message" : ""
}

源文件信息获取

获取文件信息列表

GET https://file.bimface.com/files
说明

根据多种查询条件获取文件详细信息列表,支持分页

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Query

endTime
可选

截止日期,格式为 yyyy-MM-dd

string

Query

offset
可选

查询结果偏移

integer (int64)

Query

rows
可选

查询结果数, 默认为100, 最大500

integer (int64)

100

Query

scope
可选

scope

string

Query

startTime
可选

起始日期,格式为 yyyy-MM-dd

string

Query

status
可选

文件状态,uploading,success,failure

string

Query

suffix
可选

文件后缀

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/files
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  } ],
  "message" : ""
}

获取文件信息

GET https://file.bimface.com/metadata
说明

根据文件ID获取文件详细信息

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileId
必填

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/metadata?fileId=1419273043501216
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  },
  "message" : ""
}

应用支持的文件类型

GET https://file.bimface.com/support
说明

获取当前应用支持转换的文件类型,如上传的文件格式不在列表里,BIMFACE不支持对其发起转换。

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/support
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "length" : 1073741824,
    "types" : [ "rvt", "rfa", "dwg", "dxf", "skp", "ifc", "dgn", "obj", "stl", "3ds", "dae", "ply", "igms", "zip", "gtj", "bfcatzip" ]
  },
  "message" : ""
}

源文件下载

获取文件下载链接

GET https://file.bimface.com/download/url
说明

应用通过该接口获取文件的下载地址,然后下载文件。下载地址有效时间是5分钟

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileId
必填

文件ID

integer (int64)

Query

name
可选

文件名

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/download/url?fileId=1419273043501216
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

源文件删除

删除文件

DELETE https://file.bimface.com/file
说明

根据文件ID删除文件

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileId
必填

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/file?fileId=1418750515413120
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

文件转换

在代表模型的源文件上传到BIMFACE后,一般会进行三种API调用操作:

  1. 发起模型转换

  2. 查询转换状态

  3. 如转换成功,获取模型转换后的BIM数据

在模型成功进行转换后,模型内的BIM信息会在云端进行解析,抽取并结构化入库。这些信息包含:
  • 构件属性信息

  • 构件分类树

  • 楼层

  • 单体

  • 专业

  • 构件材质

  • 模型链接

  • 空间

  • 房间

  • 图纸

  • …​

在确认模型转换成功后,为了开发者能方便的获取这些BIM信息并集成在自己的应用中,BIMFACE提供了一系列的数据接口,这些接口支持两种验权方式:

Access token

代表自身应用的身份,使用应用的appkey, secret,通过调用/oauth2/token接口获取。

View token

代表对单个模型的访问权限,使用access token,通过调用/view/token以及相关接口获得。

发起源文件/模型转换

发起转换

PUT https://api.bimface.com/translate
说明

源文件上传成功后,即可发起对该文件的转换。由于转换不能立即完成,BIMFace支持在文件转换完成以后,通过Callback机制通知应用;另外,应用也可以通过接口查询转换状态

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Body

request
必填

FileTranslateRequest请求体

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/translate
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "callback" : "https://api.glodon.com/viewing/callback?authCode=iklJk0affae&signature=2ef131395fb6442eb99abd83d45c3201",
  "config" : {
    "string" : "string"
  },
  "priority" : 2,
  "source" : {
    "compressed" : false,
    "fileId" : 1277823232112,
    "rootName" : "rootFileName.rvt"
  }
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-12-25 17:23:46",
    "databagId" : "9b711803a43b92d871cde346b63e5019",
    "fileId" : 1248789071339712,
    "name" : "bimface_2018.rvt",
    "priority" : 2,
    "reason" : "reason",
    "status" : "success",
    "thumbnail" : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png", "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/256.png" ]
  },
  "message" : ""
}

另外几种发起转换的请求体示例:
1. DWG文件转换
(1)DWG文件转换成图片

{
    "source":{
        "fileId":857482189666208,
        "compressed":false,
        "rootName":"root.dwg"
    },
    "priority":2,
    "callback":"http://www.app.com/receive",
    "config":null
}

(2)DWG文件转换成矢量图纸

{
    "source":{
        "fileId":1402934652281952,
        "compressed":false
    },
    "priority":2,
    "config":{
    	"exportDrawing":true,
    	"exportThumb":true
    },
    "callback":"http://www.app.com/receive"
}

2. RVT文件转换
(1)RVT文件转换成着色模式的效果

{
    "source":{
        "fileId":857482189666208,
        "compressed":false,
        "rootName":"root.rvt"
    },
    "priority":2,
    "callback":"http://www.app.com/receive",
    "config":null
}

(2)RVT文件转换成真实模式的效果

{
    "source":{
        "fileId":857482189666208,
        "compressed":false,
        "rootName":"root.rvt"
    },
    "priority":2,
    "callback":"http://www.app.com/receive",
    "config":{"texture":true}
}

3. 其它三维模型文件转换
(1)常规转换(不带材质)

{
    "source":{
        "fileId":857482189666208,
        "compressed":false,
        "rootName":"root.skp"
    },
    "priority":2,
    "callback":"http://www.app.com/receive",
    "config":null
}

(2)其他三维模型文件包括RVT格式文件,需要转换出引用的外部材质场景、贴图等(上传的文件必须为压缩包,压缩包内同级目录包含模型文件和关联的所有材质文件,转换时必须指定rootName为主文件)

{
    "source":{
        "fileId":1234621112557376,
        "compressed":true,
        "rootName":"bimface_2018_打包材质&系统材质库.rvt"
    },
    "priority":2,
    "callback":"http://www.app.com/receive",
    "config":{"texture":true}
}

4. 二三维联动
(1)RVT格式文件具备二三维联动的功能

{
    "source":{
        "fileId":1402934652281952,
        "compressed":false
    },
    "priority":2,
    "config":{
    	"texture": false,
		"exportDwg": true,
		"exportPdf": true,
		"exportDrawing": true
    },
    "callback":"http://www.app.com/receive"
}

请求体内的参数解释:

字段

类型

必填

描述

示例

fileId

Number

Y

文件Id,即调用上传文件API返回的fileId

857482189666208

compressed

Boolean

N

是否为压缩文件,默认为false

true, false

rootName

String

N

如果是压缩文件,必须指定压缩包中哪一个是主文件

root.rvt

priority

Number

优先级,数字越大,优先级越低

1, 2, 3

callback

String

N

Callback地址,待转换完毕以后,BIMFace会回调该地址

http://www.app.com/receive

config

Json Object

N

转换引擎自定义参数,config参数跟转换引擎相关,不同的转换引擎支持不同的config格式。例如转换时添加内置材质,则添加参数值{"texture":true},添加外部材质时参考“使用模型外置材质场景”请求报文

{"texture":true}等

回调(Callback)
待BIMFace转换完毕后,根据应用传入的回调地址,BIMFace会通知转换结果,转换可能成功、也可能失败。
HTTP方法

GET

key value 示例

Content-Type

application/json

Url参数
字段 类型 描述

fileId

Number

文件ID

status

String

转换的结果

reason

String

若转换失败,则返回失败原因

thumbnail

String

缩略图地址

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFace发出的,应用在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:fileId:status:nonce''),如果应用计算的签名与BIMFace返回的签名一致,则证明该消息是安全可靠的。
消息回执
应用收到回调后,须向BIMFace发送回执,回执消息:HTTP STATUS 200

获取转换状态

GET https://api.bimface.com/translate
说明

应用发起转换以后,可以通过该接口查询转换状态

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

fileId
必填

文件id

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/translate?fileId=857482189666208
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-12-25 17:23:46",
    "databagId" : "9b711803a43b92d871cde346b63e5019",
    "fileId" : 1248789071339712,
    "name" : "bimface_2018.rvt",
    "priority" : 2,
    "reason" : "reason",
    "status" : "success",
    "thumbnail" : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png", "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/256.png" ]
  },
  "message" : ""
}

获取模型数据

构件ID分页查询说明

curl -H "Authorization: Bearer 052d06fc-02f8-44da-8fe8-0e4cfa696d9d" https://api.bimface.com/data/v2/query/paginationContextId

curl 'https://api.bimface.com/data/v2/files/1211223382064960/elementIds?paginationContextId=c13dd5b5-8c32-4ba5-b4bd-26415a7ec48f&paginationSize=4&floor=2F&categoryId=-2000080&family=%E4%B9%A6%E6%9F%9C2&familyType=%E4%B9%A6%E6%9F%9C2&view_token=de0da756c74a4aec9b570fa506a33273'
  1. 首先取得paginationContextId,有效时间5分钟

  2. 使用第一步的接口循环调用分页查询接口

  3. 当返回结果数目小于paginationSize时停止调用,若继续调用会报错。

参数说明

​ 1. paginationSize可以不传,默认1000,取值范围(0,10000] 2. paginationNo 在公有云建议不传,若传的话,必须严格等于调用查询接口的次数 3. 第一次调用查询接口查询参数有效,之后的调用查询参数无效,第二次以后建议不传。

以文件1211223382064960为例,【floor=2F&categoryId=-2000080&family=%E4%B9%A6%E6%9F%9C2】 有11个element,推荐的查询方法为:

第一步: 拿到paginationContextId

curl -H "Authorization: Bearer 052d06fc-02f8-44da-8fe8-0e4cfa696d9d" https://api.bimface.com/data/v2/query/paginationContextId

第二步:循环调用分页查询接口

    第一次查询:

        curl 'https://api.bimface.com/data/v2/files/1211223382064960/elementIds?paginationContextId=d7e3a2ec-5f82-4ca7-ba99-dd054347d099&paginationSize=4&floor=2F&categoryId=-2000080&family=%E4%B9%A6%E6%9F%9C2&familyType=%E4%B9%A6%E6%9F%9C2&view_token=de0da756c74a4aec9b570fa506a33273'
    返回4条结果

    说明:
        第一次查询paginationSize参数有效
        paginationNo建议不传,若要传,必须为0
        查询参数floor、categoryId、family、familyType有效

    第二次查询:
    curl 'https://api.bimface.com/data/v2/files/1211223382064960/elementIds?paginationContextId=d7e3a2ec-5f82-4ca7-ba99-dd054347d099&view_token=de0da756c74a4aec9b570fa506a33273'

    返回4条结果

    说明:
        paginationSize建议不传,若要传,必须为4,不然会报错
        paginationNo建议不传,若要传,必须为1
        查询参数floor、categoryId、family、familyType无效,建议不传,若传了不会报错,但是不生效

    第三次查询:
    curl 'https://api.bimface.com/data/v2/files/1211223382064960/elementIds?paginationContextId=d7e3a2ec-5f82-4ca7-ba99-dd054347d099&view_token=de0da756c74a4aec9b570fa506a33273'

    返回3条结果

    说明:
        paginationSize建议不传,若要传,必须为4,不然会报错
        paginationNo建议不传,若要传,必须为2
        查询参数floor、categoryId、family、familyType无效,建议不传,若传了不会报错,但是不生效

        发现 3 < 4,所以不再发起第四次查询,若继续发起,会报错。

查询满足条件的构件ID列表

GET https://api.bimface.com/data/v2/files/{fileId}/elementIds
说明

根据六个维度(专业,系统类型,楼层,构件类型,族,族类型)获取对应的构件ID列表,任何维度都是可选的。

构件ID分页查询相关请参考这里

同时,也支持根据空间关系从房间计算出房间内的构件ID列表

构件与房间空间关系计算相关请参考这里
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Query

allNull
可选

boolean

Query

categoryId
可选

string

Query

family
可选

string

Query

familyType
可选

string

Query

floor
可选

string

Query

paginationContextId
可选

string

Query

paginationNo
可选

integer (int32)

Query

paginationSize
可选

integer (int32)

Query

roomId
可选

string

Query

roomToleranceXY
可选

enum (STRICT, ORDINARY, LENIENT)

Query

roomToleranceZ
可选

enum (STRICT, ORDINARY, LENIENT)

Query

specialty
可选

string

Query

systemType
可选

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/elementIds
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "message" : "string",
  "data" : ""
}

获取构件材质列表

GET https://api.bimface.com/data/v2/files/{fileId}/elements/{elementId}/materials
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

代表该单模型的构件ID

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/elements/618987/materials
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "id" : "2856106",
    "name" : "METAL_(229,80,30)Steel",
    "parameters" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  } ],
  "message" : ""
}

批量获取构件属性

GET https://api.bimface.com/data/v2/files/{fileId}/elements
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Body

filterRequest
必填

filterRequest

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/elements
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "elementIds" : [ "313154", "313047" ],
  "filter" : [ {
    "group" : "default"
  }, {
    "group" : "shape"
  }, {
    "group" : "size",
    "keys" : [ "length", "width", "a" ]
  } ]
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  } ],
  "message" : ""
}

获取构件属性

GET https://api.bimface.com/data/v2/files/{fileId}/elements/{elementId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

代表该单模型的构件ID

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/elements/1109329
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

获取多个模型的楼层信息

GET https://api.bimface.com/data/v2/files/{fileIds}/fileIdfloorsMappings
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileIds
必填

多个模型的文件ID

< string > array(multi)

Query

includeArea
可选

是否将楼层中的面积分区ID、名称一起返回

boolean

Query

includeRoom
可选

是否将楼层中的房间ID、名称一起返回

boolean

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/{fileIds}/fileIdfloorsMappings?fileIds=string
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

获取模型链接信息

GET https://api.bimface.com/data/v2/files/{fileId}/links
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/links
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "guid" : "ffb665b7-067f-4cd6-b080-214e96db0f73-00058185",
    "id" : 0,
    "name" : "file_link.rvt : 12 : loc <not shared>",
    "transform" : ""
  } ],
  "message" : ""
}

获取单个房间信息

GET https://api.bimface.com/data/v2/files/{fileId}/rooms/{roomId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Path

roomId
必填

房间ID

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/rooms/857279
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "area" : 7.256476003661832E7,
    "bboxMax" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "bboxMin" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 40087.80000000279,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

单模型获取楼层对应面积分区列表

GET /v2/files/{fileId}/areas
参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

"bearer "

Path

fileId
必填

fileId

integer (int64)

Query

floorId
必填

floorId

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • application/json

  • */*

HTTP请求示例
请求 path
/v2/files/0/areas?floorId=string
请求 header
"string"
HTTP响应示例
响应 200
{
    "code": "success",
    "message": null,
    "data": {
        "area": 1.1553530579753904E8,
        "id": "313467",
        "levelId": "311",
        "maxPt": {
            "x": 41138.76741884078,
            "y": 8200.496116135491,
            "z": 0.0
        },
        "minPt": {
            "x": 25938.767418840762,
            "y": 599.489155771088,
            "z": 0.0
        },
        "name": "2 2",
        "perimeter": 45602.01392072883,
        "properties": [
            {
                "group": "其他",
                "items": [
                    {
                        "key": "面积类型",
                        "unit": "",
                        "value": "建筑公共面积",
                        "valueType": 4
                    }
                ]
            },
            {
                "group": "尺寸标注",
                "items": [
                    {
                        "key": "计算高度",
                        "unit": "mm",
                        "value": "0",
                        "valueType": 2
                    },
                    {
                        "key": "面积",
                        "unit": "m²",
                        "value": "115.54",
                        "valueType": 2
                    }
                ]
            },
            {
                "group": "标识数据",
                "items": [
                    {
                        "key": "注释",
                        "unit": "",
                        "value": "",
                        "valueType": 3
                    },
                    {
                        "key": "编号",
                        "unit": "",
                        "value": "2",
                        "valueType": 3
                    }
                ]
            },
            {
                "group": "限制条件",
                "items": [
                    {
                        "key": "标高",
                        "unit": "",
                        "value": "标高 1",
                        "valueType": 4
                    }
                ]
            }
        ],
        "viewName": "标高 1"
    }
}
失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

获取单个面积分区信息

GET https://api.bimface.com/data/v2/files/{fileId}/areas/{areaId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

areaId
必填

面积分区ID

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/areas/313467
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "area" : 5.168684733047761E7,
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 28802.013920728663,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ],
    "viewName" : "1 1"
  },
  "message" : ""
}

获取构件分类树

GET https://api.bimface.com/data/v2/files/{fileId}/tree
说明

单模型构件分类树, treeType接受两个值:default和customized,默认为default. v参数用来区别treeType为default时返回树的格式, customized总是返回格式2.0的构件树. 当treeType为"customized"时 - desiredHierarchy表示了筛选树的层次,可选值有building,systemType,specialty,floor,category,family,familyType,如:desiredHierarchy=specialty,systemtype - customizedNodeKeys: 用来指定筛选树每个维度用id或者是name作为唯一标识, 如"floor":"id"

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Query

treeType
可选

分类树的类型

string

"default"

Query

v
可选

格式

string

Body

fileTreeRequest
可选

fileTreeRequest

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/tree
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "customizedNodeKeys" : {
    "string" : "string"
  },
  "desiredHierarchy" : [ "category", "family" ]
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}
其他请求体示例和返回示例

请求2.0的默认分类树(floor, category, family, familyType)

请求URL
https://api.bimface.com/data/v2/files/1211223382064960/tree?v=2.0
返回体示例
{
    "code": "success",
    "message": null,
    "data": [
        {
            "actualName": "1F",
            "data": null,
            "elementCount": 18,
            "id": "694",
            "items": [
                {
                    "actualName": "栏杆扶手",
                    "data": null,
                    "elementCount": 18,
                    "id": "-2000126",
                    "items": [
                        {
                            "actualName": "栏杆扶手",
                            "data": null,
                            "elementCount": 18,
                            "id": "",
                            "items": [
                                {
                                    "actualName": "栏杆",
                                    "data": null,
                                    "elementCount": 1,
                                    "id": null,
                                    "items": [],
                                    "name": "栏杆",
                                    "type": "familyType"
                                }
                            ],
                            "name": "栏杆扶手",
                            "type": "family"
                        }
                    ],
                    "name": "栏杆扶手",
                    "type": "category"
                }
            ],
            "name": "1F",
            "type": "floor"
        }
    ]
}

请求自定义树(floor, category, family, familyType)

请求URL
https://api.bimface.com/data/v2/files/1211223382064960/tree?v=2.0&treeType=customized
请求体示例
{
    "desiredHierarchy": [
        "category",
        "family"
    ],
    "customizedNodeKeys": {
        "category": "name"
    }
}
返回体示例
{
    "code": "success",
    "message": null,
    "data": {
        "items": [
            {
                "actualName": "专用设备",
                "data": null,
                "elementCount": 6,
                "id": "-2001350",
                "items": [
                    {
                        "actualName": "投影仪-基于天花板 3D",
                        "data": null,
                        "elementCount": 3,
                        "id": "",
                        "items": [

                        ],
                        "name": "投影仪-基于天花板 3D",
                        "type": "family"
                    },
                    {
                        "actualName": "投影屏幕-基于天花板 3D",
                        "data": null,
                        "elementCount": 3,
                        "id": "",
                        "items": [

                        ],
                        "name": "投影屏幕-基于天花板 3D",
                        "type": "family"
                    }
                ],
                "name": "卫浴装置",
                "type": "category"
            }
        ],
        "root": "category"
    }
}

获取三维视点或二维视图列表

GET https://api.bimface.com/data/v2/files/{fileId}/views
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/views
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "cropBox" : [ -12147.804809235151, -19279.554054815613, -30480.0, 22637.545576143948, 6805.089759789783, 30480.0 ],
    "elevation" : 0.0,
    "id" : "312",
    "levelId" : "312",
    "name" : "Level 1",
    "outline" : [ -146.52900292249365, -215.01048476685295, 240.3331231070219, 110.78415780710446 ],
    "preview" : {
      "height" : 0,
      "path" : "path",
      "width" : 0
    },
    "thumbnails" : [ "m.bimface.com/9b711803a43b92d871cde346b63e5019/resource/thumbnails/312/312.96x96.png" ],
    "viewPoint" : {
      "origin" : [ 0.0 ],
      "rightDirection" : [ 0.0 ],
      "scale" : 0,
      "upDirection" : [ 0.0 ],
      "viewDirection" : [ 0.0 ]
    },
    "viewType" : "FloorPlain"
  } ],
  "message" : ""
}

获取图纸列表

GET https://api.bimface.com/data/v2/files/{fileId}/drawingsheets
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/drawingsheets
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "fileId" : 0,
    "portsAndViews" : [ {
      "elevation" : 0.0,
      "outline" : [ 0.0 ],
      "viewId" : "c651a4d98cf1416381605dd8b3571878",
      "viewPoint" : {
        "origin" : [ 0.0 ],
        "rightDirection" : [ 0.0 ],
        "scale" : 0,
        "upDirection" : [ 0.0 ],
        "viewDirection" : [ 0.0 ]
      },
      "viewType" : "viewType",
      "viewport" : [ 0.0 ]
    } ],
    "viewInfo" : {
      "cropBox" : [ -12147.804809235151, -19279.554054815613, -30480.0, 22637.545576143948, 6805.089759789783, 30480.0 ],
      "elevation" : 0.0,
      "id" : "312",
      "levelId" : "312",
      "name" : "Level 1",
      "outline" : [ -146.52900292249365, -215.01048476685295, 240.3331231070219, 110.78415780710446 ],
      "preview" : {
        "height" : 0,
        "path" : "path",
        "width" : 0
      },
      "thumbnails" : [ "m.bimface.com/9b711803a43b92d871cde346b63e5019/resource/thumbnails/312/312.96x96.png" ],
      "viewPoint" : {
        "origin" : [ 0.0 ],
        "rightDirection" : [ 0.0 ],
        "scale" : 0,
        "upDirection" : [ 0.0 ],
        "viewDirection" : [ 0.0 ]
      },
      "viewType" : "FloorPlain"
    }
  } ],
  "message" : ""
}

模型集成

随着建筑信息化模型技术的发展,越来越多的人选择在云端浏览建筑模型。现阶段的云端模型浏览大多是基于文件级别, 一次只可以浏览一个模型文件中的内容。而在工程项目模型设计的过程中,通常由多个设计师协同设计, 不同的设计师负责不同的专业领域(例如建筑、结构、水电等)。如果想要在云端浏览整个项目工程, 就需要把这些组成部分集成起来一起展示。更近一步,如果要在集成的模型之上进行业务集成的话, 就要求在集成过程中对构件按单体,楼层,专业,构件分类,系统类型等进行分类或映射。

现有的最接近的方案一般是用Revit建模,然后再把多专业的模型导入到Navisworks中,但这样的方法有如下的缺点:
  • 即使是满足浏览模型的需求,也需要安装Revit以及Navisworks软件。

  • 在Navisworks里进行的模型导入只做了几何的导入集成,不支持上面提到的建筑领域各种分类信息。

  • 只支持Windows操作系统,不支持桌面端的MacOS, Linux等操作系统以及移动端的iOS和安卓操作系统。

针对上述的限制,BIMFACE的模型集成,能完美解决上述的所有问题。

在业务方面,BIMFACE的模型集成能:
  • 集成不同专业的模型,包括建筑、结构、装修、幕墙、钢构,以及机电中给排水、采暖燃气、通风空调、消防、强弱电等各专业。

  • 自定义楼层映射

  • 支持单体,系统类型,构件类型等其他分类维度

  • 支持模型链接集成,如带标准层的集成模型

  • 支持自定义文件转换矩阵(transform)

在技术方法,BIMFACE的模型集成充分运用了云端无穷的计算资源,在模型集成过程中:

  • 运用图形几何算法进行了如下优化,大大提升在浏览器里能展示模型的规模以及渲染的性能:

    • 识别基本体

    • 实例绘制优化

    • 同材质全场景动态合并

    • 外围壳光线追踪识别

  • 构件属性在云端进行入库索引,提供任意的属性查询能力。

对于revit文件来说,当单个文件转换成功以后,可以将多个revit文件集成,生成一个全专业/楼层模型。由于集成不能立即完成,BIMFACE支持在模型集成完成以后,通过Callback机制通知调用方;另外,调用方也可以通过接口查询集成状态。

模型集成发起相关

发起模型集成

PUT https://api.bimface.com/integrate
说明

对于参与集成的文件来说,当单个文件转换成功以后,可以将多个文件集成,生成一个全专业/楼层模型。由于集成不能立即完成,BIMFACE支持在模型集成完成以后,通过Callback机制通知调用方;另外,调用方也可以通过接口查询集成状态

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Body

request
必填

模型集成请求体

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrate
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "callback" : "https://api.glodon.com/viewing/callback?authCode=6kj0Jk0affae&signature=2ef131395fb6442eb99abd83d45c6016",
  "config" : "config",
  "floorMapping" : [ {
    "fileFloorId" : "pj1101",
    "projectFloorId" : "pj11",
    "projectFloorName" : "firstfloor"
  } ],
  "floorSort" : [ "5" ],
  "internalConfigMap" : {
    "string" : "string"
  },
  "name" : "model.rvt",
  "parentIntegrateId" : 0,
  "priority" : 2,
  "propertyOverrides" : [ {
    "keyToMatch" : "system_type",
    "keyToOverride" : "specialty",
    "targetFileIds" : [ "1468861829161440", "1468862035943904" ],
    "valueOverrides" : [ {
      "valueToMatch" : "water_support_pipe",
      "valueToOverride" : "water_support"
    } ]
  } ],
  "ruleFileIds" : [ 1232134213412 ],
  "sourceId" : "hduf2w3ho21nowr23rqwjrn2o3",
  "sources" : [ {
    "building" : "GlodonBuilding",
    "databagId" : "h2h2312223",
    "fileId" : 12311221,
    "fileName" : "model.rvt",
    "floor" : "F01",
    "floorSort" : 0.1,
    "specialty" : "AR",
    "specialtySort" : 0.1,
    "transform" : [ 1.23 ]
  } ],
  "specialtySort" : [ "2" ]
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-12-25 17:25:25",
    "integrateId" : 1248789977538784,
    "name" : "integrate-x",
    "priority" : 2,
    "reason" : "reason",
    "sourceId" : "123156522123",
    "status" : "success",
    "thumbnail" : [ "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/96.png", "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/256.png" ]
  },
  "message" : ""
}
请求体参数说明
字段 类型 必填 描述 示例

sources

Source[]

Y

待集成的文件列表

source.fileId

Number

Y

待集成的源文件ID,必须是 rvt 文件

9220020202001

source.specialty

String

N

待集成源文件对应的专业名称

AR

source.specialtySort

Number

N

显示专业层次结构时,排序数值越小,排序越前

0.1

source.floor

String

N

待集成源文件对应的楼层名称

F01

source.floorSort

Number

N

显示楼层层次结构时,排序数值越小,排序越前

0.1

sourceId

String

N

调用方的源ID

857482189666208

name

String

N

调用方设置的名称

我的合并模型

priority

Number

优先级,数字越大,优先级越低

1, 2, 3

callback

String

N

Callback地址,待集成完毕以后,BIMFACE会回调该地址

http://www.app.com/receive

CURL命令示例
curl -X PUT
-H "Authorization: bearer <your accessToken>"
-H "Content-Type: application/json"
-d '{
    "sources": [
        {
            "fileId": 9220020202001,
            "specialty": "AR",
            "specialtySort": 0.1,
            "floor": "F01",
            "floorSort": 0.1
        },
        {
            "fileId": 9220020202002,
            "specialty": "AR",
            "specialtySort": 0.1,
            "floor": "F02",
            "floorSort": 0.2
        }
    ],
    "sourceId":"123456",
    "name":"我的合并模型",
    "priority": 2,
    "callback": "http://www.app.com/receive"
}'
"https://api.bimface.com/integrate"
返回参数说明
字段 类型 描述 示例

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访问合法性校验失败

input.parameter.error

输入的参数有误

priority.not.support

不支持输入的优先级

url.invalid

回调地址不是正确的URL

file.not.found

文件不存在

file.type.not.support

不支持当前文件发起集成,目前仅支持revit文件

file.has.not.translated

文件没有发起转换,不能集成

file.is.translating

文件正在转换中,不能集成

file.translate.failed

文件转换失败,不能集成


回调(Callback)
待集成完毕后,根据调用方传入的回调地址,BIMFACE会通知结果。
HTTP方法

GET

Header
key value 示例

Content-Type

application/json

Url参数
字段 类型 描述 示例

integrateId

Number

集成Id

85929027838566

status

String

集成的结果

success(集成成功)、failed(集成失败)

reason

String

若集成失败,则返回失败原因

thumbnail

String

缩略图地址

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFACE发出的,调用方在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:integrateId:status:nonce''),如果调用方计算的签名与BIMFACE返回的签名一致,则证明该消息是安全可靠的。
消息回执
调用方收到回调后,须向BIMFACE发送回执,回执消息:HTTP STATUS 200

查询集成状态

GET https://api.bimface.com/integrate
说明

调用方发起集成以后,可以通过该接口查询集成状态

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

integrateId
必填

集成模型id

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrate?integrateId=857482189666208
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-12-25 17:25:25",
    "integrateId" : 1248789977538784,
    "name" : "integrate-x",
    "priority" : 2,
    "reason" : "reason",
    "sourceId" : "123156522123",
    "status" : "success",
    "thumbnail" : [ "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/96.png", "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/256.png" ]
  },
  "message" : ""
}

删除集成模型

DELETE https://api.bimface.com/integrate
说明

根据集成模型id删除集成模型

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

integrateId
必填

集成模型id

integer (int64)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrate?integrateId=857482189666208
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

集成模型数据

获取指定构件的属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/elements/{elementId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

构件ID

string

Path

integrateId
必填

集成ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/elements/313052
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

获取多个构件的公共属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/commonElementProperties
说明

若传入的elementId不止一个,则返回这些elementId共同的属性,共同的定义为:属性key与value都相等

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Body

fileIdHashWithElementIdsList
可选

fileIdHashWithElementIdsList

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/commonElementProperties
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
[ {
  "fileIdHash" : "1365346274583424",
  "elementIds" : [ "13200421233953227195", "4979270284117701525", "-8098347145579605232" ]
} ]
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

获取子文件/链接内的指定构件的属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/files/{fileIdHash}/elements/{elementId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

构件ID

string

Path

fileIdHash
必填

文件ID

string

Path

integrateId
必填

集成ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1432597241469056/files/8bf8b9c295382c30c9803fc4ca21278e/elements/313052
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

批量获取构件属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/elements
说明

在请求体里可以传入多个指定子文件/链接内的构件ID列表来批量获取属性

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Body

fileIdHashWithElementIdsList
可选

fileIdHashWithElementIdsList

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/elements
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
[ {
  "fileIdHash" : "1365346274583424",
  "elementIds" : [ "13200421233953227195", "4979270284117701525", "-8098347145579605232" ]
} ]
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  } ],
  "message" : ""
}

获取参与集成的子文件列表

GET https://api.bimface.com/data/v2/integrations/{integrateId}/files
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeDrawingSheet
可选

是否将文件下转换出的图纸数量一起返回

boolean

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1324505536227744/files
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "databagId" : "85f49f848c5f6ac0ff7f21a72db1f82c",
    "drawingSheetCount" : 2,
    "fileId" : 1315961640976832,
    "fileName" : "file_link.rvt",
    "floor" : "1F",
    "floorSort" : 0.5,
    "integrateId" : 1324505536227744,
    "linkedBy" : [ "539116d4c6e3826f893dd5ae0b0104da", "ae2995e27f5c8fa4e064a710302a3885" ],
    "specialty" : "civil",
    "specialtySort" : 0.1
  } ],
  "message" : ""
}

查询满足条件的构件ID列表

GET https://api.bimface.com/data/v2/integrations/{integrateId}/elementIds
说明

根据六个维度(专业,系统类型,楼层,构件类型,族,族类型)获取对应的构件ID列表,任何维度都是可选的。

构件ID分页查询相关请参考这里

同时,也支持根据空间关系从房间计算出房间内的构件ID列表

构件与房间空间关系计算相关请参考这里
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

allNull
可选

boolean

Query

categoryId
可选

string

Query

family
可选

string

Query

familyType
可选

string

Query

floor
可选

string

Query

paginationContextId
可选

string

Query

paginationNo
可选

integer (int32)

Query

paginationSize
可选

integer (int32)

Query

roomId
可选

string

Query

roomToleranceXY
可选

enum (STRICT, ORDINARY, LENIENT)

Query

roomToleranceZ
可选

enum (STRICT, ORDINARY, LENIENT)

Query

specialty
可选

string

Query

systemType
可选

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1424944692329120/elementIds
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elements" : [ {
      "fileId" : "cce34cec5412bfdb412b97d4fd0b30ec",
      "elementId" : "313052"
    } ]
  },
  "message" : ""
}

获取分类树

GET https://api.bimface.com/data/v2/integrations/{integrateId}/tree
说明

集成模型默认楼层分类树(v2.0), treeType接受三个值:floor, specialty和customized, 当treeType为"customized", 则desiredHierarchy表示了筛选树的层次,如:desiredHierarchy=specialty,systemtype

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

desiredHierarchy
可选

分类树的层次结构

< string > array(multi)

Query

treeType
可选

分类树类型

string

"floor"

Body

requestBody
可选

指定排序,显示的构件列表等可选项

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/tree
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "customizedNodeKeys" : {
    "string" : "string"
  },
  "fileIdElementIds" : [ {
    "fileId" : "cce34cec5412bfdb412b97d4fd0b30ec",
    "elementId" : "313052"
  } ],
  "sortedNamesHierarchy" : [ [ "string" ] ],
  "sorts" : [ {
    "nodeType" : "3",
    "sortBy" : "SORT_BY_NAME",
    "sortedValues" : [ "string" ]
  } ]
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "items" : [ {
      "actualName" : "actualName",
      "data" : "object",
      "elementCount" : 0,
      "id" : "24926a46f3ad42ba8f718b70dd91ee3e",
      "items" : [ {
        "actualName" : "actualName",
        "data" : "object",
        "elementCount" : 0,
        "id" : "24926a46f3ad42ba8f718b70dd91ee3e",
        "items" : [ "..." ],
        "name" : "name",
        "type" : "type"
      } ],
      "name" : "name",
      "type" : "type"
    } ],
    "root" : "specialty"
  },
  "message" : ""
}
其他请求体示例和返回示例

请求楼层分类树(floor, specialty, category, family, familyType)

请求URL
https://api.bimface.com/data/v2/integrations/1211286711525184/tree?treeType=floor
返回体示例:
{
	"code": "success",
	"message": null,
	"data": {
		"items": [{
			"actualName": "1F",
			"data": null,
			"elementCount": 1576,
			"id": "0",
			"items": [{
				"actualName": "通风空调",
				"data": null,
				"elementCount": 1195,
				"id": "0",
				"items": [{
					"actualName": "喷头",
					"data": null,
					"elementCount": 1068,
					"id": "-2008099",
					"items": [{
						"actualName": "喷头 - 下垂型",
						"data": null,
						"elementCount": 803,
						"id": "",
						"items": [{
							"actualName": "20 mm",
							"data": null,
							"elementCount": 803,
							"id": null,
							"items": [],
							"name": "20 mm",
							"type": "familyType"
						}],
						"name": "喷头 - 下垂型",
						"type": "family"
					}],
					"name": "喷头",
					"type": "category"
				}],
				"name": "通风空调",
				"type": "specialty"
			}],
			"name": "1F",
			"type": "floor"
		}],
		"root": "楼层"
	}
}

请求专业分类树(specialty, floor, category, family, familyType)

请求URL
https://api.bimface.com/data/v2/integrations/1211286711525184/tree?treeType=specialty
返回体示例
{
	"code": "success",
	"message": null,
	"data": {
		"items": [{
			"actualName": "通风空调",
			"data": null,
			"elementCount": 41724,
			"id": "0",
			"items": [{
				"actualName": "F06",
				"data": null,
				"elementCount": 130,
				"id": "268430",
				"items": [{
					"actualName": "电缆桥架",
					"data": null,
					"elementCount": 74,
					"id": "-2008130",
					"items": [{
						"actualName": "带配件的电缆桥架",
						"data": null,
						"elementCount": 74,
						"id": "",
						"items": [{
							"actualName": "弱电桥架",
							"data": null,
							"elementCount": 56,
							"id": null,
							"items": [],
							"name": "弱电桥架",
							"type": "familyType"
						}],
						"name": "带配件的电缆桥架",
						"type": "family"
					}],
					"name": "电缆桥架",
					"type": "category"
				}],
				"name": "F06",
				"type": "floor"
			}],
			"name": "通风空调",
			"type": "specialty"
		}],
		"root": "专业"
	}
}

请求自定义分类树

请求URL
https://api.bimface.com/data/v2/integrations/1211286711525184/tree?desiredHierarchy=floor%2Cspecialty%2Ccategory%2Cfamily%2CfamilyType&treeType=customized
请求体示例
{
    "desiredHierarchy": [
        "category",
        "family"
    ],
    "customizedNodeKeys": {
        "category": "name"
    }
}
返回体示例
{
	"code": "success",
	"message": null,
	"data": {
		"items": [{
			"actualName": "F06",
			"data": null,
			"elementCount": 1,
			"id": "0",
			"items": [{
				"actualName": "土建",
				"data": null,
				"elementCount": 1,
				"id": "0",
				"items": [{
					"actualName": "结构框架",
					"data": null,
					"elementCount": 1,
					"id": "-2001320",
					"items": [{
						"actualName": "结构框架 1",
						"data": null,
						"elementCount": 1,
						"id": "",
						"items": [{
							"actualName": "结构框架 1",
							"data": null,
							"elementCount": 1,
							"id": null,
							"items": [],
							"name": "结构框架 1",
							"type": "familyType"
						}],
						"name": "结构框架 1",
						"type": "family"
					}],
					"name": "结构框架",
					"type": "category"
				}],
				"name": "土建",
				"type": "specialty"
			}],
			"name": "F06",
			"type": "floor"
		}],
		"root": "楼层"
	}
}

请求自定义分类树(带自定义排序)

请求URL
https://api.bimface.com/data/v2/integrations/1211286711525184/tree?desiredHierarchy=specialty%2Cfloor%2Ccategory%2Cfamily%2CfamilyType&treeType=customized
请求体示例
{
  "sortedNamesHierarchy": [["土建"], ["B01","F01"]]
}
返回体示例
{
	"code": "success",
	"message": null,
	"data": {
		"items": [{
			"actualName": "土建",
			"data": null,
			"elementCount": 2628,
			"id": "0",
			"items": [{
					"actualName": "F01",
					"data": null,
					"elementCount": 1,
					"id": "0",
					"items": [{
						"actualName": "结构框架",
						"data": null,
						"elementCount": 1,
						"id": "-2001320",
						"items": [{
							"actualName": "结构框架 1",
							"data": null,
							"elementCount": 1,
							"id": "",
							"items": [{
								"actualName": "结构框架 1",
								"data": null,
								"elementCount": 1,
								"id": null,
								"items": [],
								"name": "结构框架 1",
								"type": "familyType"
							}],
							"name": "结构框架 1",
							"type": "family"
						}],
						"name": "结构框架",
						"type": "category"
					}],
					"name": "F01",
					"type": "floor"
				},
				{
					"actualName": "B01",
					"data": null,
					"elementCount": 347,
					"id": "694",
					"items": [{
						"actualName": "墙",
						"data": null,
						"elementCount": 68,
						"id": "-2000011",
						"items": [{
							"actualName": "基本墙",
							"data": null,
							"elementCount": 68,
							"id": "",
							"items": [{
								"actualName": "结构墙200mm-C30",
								"data": null,
								"elementCount": 1,
								"id": null,
								"items": [],
								"name": "结构墙200mm-C30",
								"type": "familyType"
							}],
							"name": "基本墙",
							"type": "family"
						}],
						"name": "墙",
						"type": "category"
					}],
					"name": "B01",
					"type": "floor"
				}
			],
			"name": "土建",
			"type": "specialty"
		}],
		"root": "专业"
	}
}

获取楼层列表

GET https://api.bimface.com/data/v2/integrations/{integrateId}/floors
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeArea
可选

是否将楼层中的空间ID、名称一起返回

boolean

Query

includeRoom
可选

是否将楼层中的房间ID、名称一起返回

boolean

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/floors
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "archElev" : 0.0,
    "areas" : [ {
      "boundary" : "",
      "id" : "313137",
      "levelId" : "11",
      "maxPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "minPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "name" : "dining room 4"
    } ],
    "elevation" : 0.0,
    "height" : 4000.0,
    "id" : "311",
    "miniMap" : "787e5907b0ca5cb35f5d10ba091a085b/resource/model/maps/elevation 1.png",
    "name" : "elevation 1",
    "rooms" : [ {
      "boundary" : "",
      "id" : "313137",
      "levelId" : "11",
      "maxPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "minPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "name" : "dining room 4"
    } ],
    "structElev" : 0.0
  } ],
  "message" : ""
}

获取指定房间的属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/rooms/{roomId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Path

roomId
必填

房间ID

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1384705681529024/rooms/1373167156769760_857279
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "area" : 7.256476003661832E7,
    "bboxMax" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "bboxMin" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 40087.80000000279,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

获取楼层对应面积分区列表

GET https://api.bimface.com/data/v2/integrations/{integrateId}/areas
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

floorId
必填

楼层ID

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1315311982340128/areas?floorId=0
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "area" : 5.168684733047761E7,
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 28802.013920728663,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ],
    "viewName" : "1 1"
  } ],
  "message" : ""
}

获取指定面积分区的属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/areas/{areaId}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

areaId
必填

面积分区ID

string

Path

integrateId
必填

集成ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1315311982340128/areas/1315296732840480_313464
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "area" : 5.168684733047761E7,
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 28802.013920728663,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ],
    "viewName" : "1 1"
  },
  "message" : ""
}

获取视图信息

GET https://api.bimface.com/data/v2/integrations/{integrateId}/fileViews
说明

根据viewType筛选结果集,viewType接受7个值:FloorPlan(楼层俯视二维视图),ThreeD(三维视图),CeilingPlan(天花板仰视二维视图),Elevation(轴侧二维视图),EngineeringPlan,Rendering,DrawingSheet;当不给出viewType值时,则返回所有集合

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

viewType
可选

视图类型

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1281366350980864/fileViews
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "fileId" : 1280438635534016,
    "views" : [ {
      "cropBox" : [ -12147.804809235151, -19279.554054815613, -30480.0, 22637.545576143948, 6805.089759789783, 30480.0 ],
      "elevation" : 0.0,
      "id" : "312",
      "levelId" : "312",
      "name" : "Level 1",
      "outline" : [ -146.52900292249365, -215.01048476685295, 240.3331231070219, 110.78415780710446 ],
      "preview" : {
        "height" : 0,
        "path" : "path",
        "width" : 0
      },
      "thumbnails" : [ "m.bimface.com/9b711803a43b92d871cde346b63e5019/resource/thumbnails/312/312.96x96.png" ],
      "viewPoint" : {
        "origin" : [ 0.0 ],
        "rightDirection" : [ 0.0 ],
        "scale" : 0,
        "upDirection" : [ 0.0 ],
        "viewDirection" : [ 0.0 ]
      },
      "viewType" : "FloorPlain"
    } ]
  } ],
  "message" : ""
}

获取指定构件的材质信息

GET https://api.bimface.com/data/v2/integrations/{integrateId}/files/{fileIdHash}/elements/{elementId}/materials
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

构件ID

string

Path

fileIdHash
必填

子文件ID

string

Path

integrateId
必填

集成ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1487943724117856/files/1434715223061056/elements/618987/materials
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "id" : "2856106",
    "name" : "METAL_(229,80,30)Steel",
    "parameters" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  } ],
  "message" : ""
}

计算指定构件列表的包围盒

GET https://api.bimface.com/data/integrations/{integrateId}/elements/boundingboxes
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
可选

模型集成ID

integer (int64)

Body

fileIdWithEleIdList
可选

构件ID列表,由','分隔.每个构件ID由fileID和elementID组成

< string > array

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/integrations/1197129466961728/elements/boundingboxes
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
[ "string" ]
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052"
  } ],
  "message" : ""
}

模型对比

模型对比可以对两个文件/模型进行差异性分析,确定两个文件/模型之间构件的几何和属性差异,包括增加的构件、删除的构件和修改的构件。 模型对应可以用于进行文件/模型的版本对比。

几何对比

几何数据的对比的粒度为构件级,即只要构件的某一部分几何数据或材质发生改变,就认为整个构件发生变化。

属性对比

属性对比的粒度为构件的属性级,即对两个文件中的相同ID的构件挨个属性值进行对比。

不同版本的模型文件上传并转换成功后,即可发起模型对比。由于对比不能立即完成,BIMFace支持在模型对比完成以后,通过Callback机制通知应用;另外,应用也可以通过接口查询对比状态。

发起模型对比

POST https://api.bimface.com/v2/compare
说明

不同版本的模型文件上传并转换成功后,即可发起模型对比。由于对比不能立即完成,BIMFace支持在模型对比完成以后,通过Callback机制通知应用;另外,应用也可以通过接口查询对比状态

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Body

request
必填

模型对比请求体

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/v2/compare
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "callback" : "https://api.glodon.com/viewing/callback?authCode=BJ90Jk0affae&signature=2ef131395fb6442eb99abd83d45c2412",
  "comparedEntityType" : "file",
  "config" : "object",
  "followingId" : 22145522,
  "name" : "compare0001",
  "previousId" : 12311221,
  "priority" : 2,
  "sourceId" : "123223223212"
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "compareId" : 1248756572307264,
    "createTime" : "2017-12-25 16:17:27",
    "name" : "compare0001",
    "priority" : 2,
    "reason" : "reason",
    "sourceId" : "123223223212",
    "status" : "succcess",
    "thumbnail" : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png" ]
  },
  "message" : ""
}
请求体参数说明
字段 类型 必填 描述 示例

previousFileId

Number

N

变更前文件ID,如果为新增文件,则为null

857482189666208

followingFileId

Number

N

变更后文件ID,如果为删除文件,则为null

857482189666209

sources

Source[]

Y

数组,多个CompareSource,待对比的文件

name

String

N

用户指定对比后的模型的名字

sourceId

String

N

第三方应用自己的ID

priority

Number

优先级,数字越大,优先级越低

1, 2, 3

callback

String

N

Callback地址,待对比完毕以后,BIMFace会回调该地址

http://www.app.com/receive

返回体参数说明
字段 类型 描述 示例

compareId

Number

对比ID

857482189666208

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

对比文件不存在


回调(Callback)
待BIMFace对比完毕后,根据应用传入的回调地址,BIMFace会通知对比结果,对比可能成功、也可能失败。
HTTP方法

GET

Header
key value 示例

Content-Type

application/json

Url参数
字段 类型 描述

compareId

Number

模型对比ID

status

String

模型对比状态

reason

String

若对比失败,则返回失败原因

thumbnail

String

模型对比模型的缩略图,多个缩略图用``,''分隔(如果有缩略图的话)

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFace发出的,应用在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:fileId:status:nonce''),如果应用计算的签名与BIMFace返回的签名一致,则证明该消息是安全可靠的。
消息回执
应用收到回调后,须向BIMFace发送回执,回执消息:HTTP STATUS 200

获取模型对比状态

GET https://api.bimface.com/v2/compare
说明

应用发起对比以后,可以通过该接口查询对比状态

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

compareId
必填

模型对比ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/v2/compare?compareId=857482189666208
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "compareId" : 1248756572307264,
    "createTime" : "2017-12-25 16:17:27",
    "name" : "compare0001",
    "priority" : 2,
    "reason" : "reason",
    "sourceId" : "123223223212",
    "status" : "succcess",
    "thumbnail" : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png" ]
  },
  "message" : ""
}
请求体说明
字段 类型 描述 示例

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

文件不存在

删除模型对比

DELETE https://api.bimface.com/v2/compare
说明

删除模型对比

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

compareId
必填

模型对比ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/v2/compare?compareId=857482189666208
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

获取模型构件对比差异

GET https://api.bimface.com/data/v2/comparisons/{comparisonId}/elementChange
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

comparisonId
可选

对比ID

integer (int64)

Query

followingElementId
可选

后一文件的构件ID

string

Query

followingFileId
可选

后一文件ID

integer (int64)

Query

previousElementId
可选

前一文件的构件ID

string

Query

previousFileId
可选

前一文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/comparisons/1136906400211168/elementChange
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "_A" : "string",
    "_B" : "string",
    "changeAttributes" : [ {
      "_A" : {
        "key" : "key",
        "unit" : "unit",
        "value" : "value"
      },
      "_B" : {
        "key" : "key",
        "unit" : "unit",
        "value" : "value"
      }
    } ],
    "changeQuantities" : [ {
      "_A" : {
        "code" : "code",
        "desc" : "desc",
        "name" : "name",
        "qty" : 0,
        "unit" : "unit"
      },
      "_B" : {
        "code" : "code",
        "desc" : "desc",
        "name" : "name",
        "qty" : 0,
        "unit" : "unit"
      }
    } ],
    "deleteAttributes" : [ {
      "key" : "key",
      "unit" : "unit",
      "value" : "value"
    } ],
    "deleteQuantities" : [ {
      "code" : "code",
      "desc" : "desc",
      "name" : "name",
      "qty" : 0,
      "unit" : "unit"
    } ],
    "newAttributes" : [ {
      "key" : "key",
      "unit" : "unit",
      "value" : "value"
    } ],
    "newQuantities" : [ {
      "code" : "code",
      "desc" : "desc",
      "name" : "name",
      "qty" : 0,
      "unit" : "unit"
    } ]
  },
  "message" : ""
}
响应 200
{
    "code": "success",
    "message": null,
    "data": {
        "A": "变化图元前一个版本的ID",
        "B": "变化图元后一个版本的ID",
        "newAttributes": [{
            "key": "属性名",
            "value": "属性值",
            "unit": ""
        }],
        "deleteAttributes": [{
            "key": "属性名",
            "value": "属性值",
            "unit": ""
        }],
        "changeAttributes": [{
            "A": {
                "key": "属性名",
                "value": "属性值",
                "unit": "",

            },
            "B": {
                "key": "属性名",
                "value": "属性值",
                "unit": "",

            }
        }],
        "newQuantities": [{                           // 表示新加入的工程量
            "code": "工程量编码(用于运算)",
            "desc": "工程量描述",
            "name": "工程量名称(用于显示)",
            "unit": "单位",
            "qty": 数值
        }],
        "deleteQuantities": [{                         // 表示删除的工程量
            "code": "工程量编码(用于运算)",
            "desc": "工程量描述",
            "name": "工程量名称(用于显示)",
            "unit": "单位",
            "qty": 数值
        }],
        "changeQuantities": [{                        // 表示变化的工程量
            "A": {                                    // 前一个版本
                "code": "工程量编码(用于运算)",
                "desc": "工程量描述",
                "name": "工程量名称(用于显示)",
                "unit": "单位",
                "qty": 数值
            },
            "B": {                                     // 后一个版本
                "code": "工程量编码(用于运算)",
                "desc": "工程量描述",
                "name": "工程量名称(用于显示)",
                "unit": "单位",
                "qty": 数值
            }
        }]
    }
}
字段 类型 描述 示例

A

String

变化图元前一个版本的ID

1274969781330112.332749

B

String

变化图元后一个版本的ID

1274969736151232.332749

newAttributes

newAttributes[]

新增属性列表

deleteAttributes

deleteAttributes[]

删除属性列表

changeAttributes

changeAttributes[]

修改属性列表

失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

compare.not.found

对比ID不存在

compare.not.complete

对比还末完成

compare.failed

对比失败

change.not.found

差异未找到

获取模型对比构件分类树

GET https://api.bimface.com/data/v2/comparisons/{comparisonId}/tree
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

comparisonId
可选

对比ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/comparisons/1136906400211168/tree
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "items" : [ {
      "actualName" : "actualName",
      "data" : "object",
      "elementCount" : 0,
      "id" : "24926a46f3ad42ba8f718b70dd91ee3e",
      "items" : [ {
        "actualName" : "actualName",
        "data" : "object",
        "elementCount" : 0,
        "id" : "24926a46f3ad42ba8f718b70dd91ee3e",
        "items" : [ "..." ],
        "name" : "name",
        "type" : "type"
      } ],
      "name" : "name",
      "type" : "type"
    } ],
    "root" : "specialty"
  },
  "message" : ""
}

分页获取模型对比结果

GET https://api.bimface.com/data/v2/comparisons/{comparisonId}/diff
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

comparisonId
可选

对比ID

integer (int64)

Query

elementName
可选

构件名称

string

Query

family
可选

string

Query

page
可选

页码

integer (int32)

Query

pageSize
可选

每页记录数

integer (int32)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/comparisons/1136906400211168/diff
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "data" : [ {
      "categoryId" : "-2001320",
      "categoryName" : "framework",
      "diffType" : "CHANGE",
      "elementId" : "296524",
      "elementName" : "250 x 600 mm",
      "family" : "framework 1",
      "followingFileId" : "1136893002033344",
      "id" : "0213154515478",
      "previousFileId" : "1136239003943104",
      "specialty" : "civil"
    } ],
    "page" : 2,
    "total" : 10
  },
  "message" : ""
}
返回体参数说明
字段 类型 描述 示例

compareId

Number

对比ID

85929027838566

differType

String

对比差异构件差异类型

NEW、DELETE、CHANGE

id

String

对比差异构件来源构件ID

specialty

String

对比差异构件所属专业

categoryName

String

对比差异构件所属类别名称

elementName

String

对比差异构件名称

family

String

对比差异构件的族名称

previousFileId

Number

对比差异构件来源文件ID

followingFileId

Number

对比差异构件变更文件ID

模型信息和构件属性查询

上传到BIMFACE的模型文件转换以及模型集成,模型对比都是在云端进行的。借助BIMFACE在云端强大的数据能力, 为满足不同的业务需要,开发者可以方便得对在转换/集成/对比过程中产生的数据进行灵活的查询检索。这是BIMFACE基于云计算的独特优势。

为满足灵活的,可扩展的查询需求,BIMFACE参考Elastic Search,定义了一套通用的查询领域语言。

查询接口中请求体相关说明

主要是参考 Elasticseach的Query DSL,可以看作是ES的DSL的子集,有些关键字有稍作改动

查询文件id为1124890692330272中,所有floor属性包含F的elementId

{
    "targetType":"file",
    "targetIds":["1124890692330272"],
    "query":{
        "contain":{
            "floor":"F"
        }
    }
}

查询文件id为1124890692330272中,所有floor属性为F11的elementId

{
    "targetType":"file",
    "targetIds":["1124890692330272"],
    "query":{
        "match":{
            "floor":"F11"
        }
    }
}

查询文件id为1124890692330272中,所有floor属性包含F并且family为标准的elementId

{
    "targetType":"file",
    "targetIds":["1124890692330272"],
    "query":{
        "boolAnd":[
            {"contain":{"floor":"F"}},
			{"match":{"family":"标准"}}
        ]
    }
}

查询文件id为1124890692330272中,所有floor属性为F11或family为标准的elementId

{
    "targetType":"file",
    "targetIds":["1124890692330272"],
    "query":{
        "boolOr":[
            {"match":{"floor":"F11"}},
			{"match":{"family":"标准"}}
        ]
    }
}

{
    "targetType":"file",
    "targetIds":["1124890692330272"],
    "query":{
       "boolOr" :  [
           { "match" : {"productID" : "KDKE-B-9947-#kL5"}},
           { "boolAnd" : [
               { "match" : {"productID" : "JODL-X-1937-#pV7"}},
               { "match" : {"price" : 30}}
             ]
           }
         ]
   }
}

等价于

SELECT elementId
FROM   XXX
WHERE  productID      = "KDKE-B-9947-#kL5"
  OR (     productID = "JODL-X-1937-#pV7"
       AND price     = 30 )

比较复杂的查询示例

{
    "targetType":"file",
    "targetIds":["1124890692330272"],
    "query":{
        "contain":{
            "floor":"B01",
            "familyType":"标准"
        },
        "match":{"family":"family1"},
        "boolAnd":[
            {"match":{"categoryId":"id111"}},
			{"match":{"boundingBox.min.x":167899.9999999998}}
        ],
        "boolOr":[
            { "match" : {"productID" : "KDKE-B-9947-#kL5"}},
            { "boolAnd" : [
               { "match" : {"productID" : "JODL-X-1937-#pV7"}},
               { "match" : {"price" : 30}}
             ]
           }
        ]
    }
}
字段 类型 必填 描述 示例

targetType

String

Y

查询目标类型,只能是file或integration

file

targetIds

String[]

Y

查询目标ID列表

[“1124890692330272”]

query

Object

Y

查询条件实体,由match、contain、boolAnd、boolOr组成

..

match

Object

N

精确匹配某个属性值

{“floor”:“F1”}

contain

Object

N

模糊匹配某个属性值

{“floor”:“1”}

boolAnd

Object[]

N

逻辑与查询,支持嵌套

..

boolOr

Object[]

N

逻辑或查询,支持嵌套

..

查询符合条件的构件ID列表

GET https://api.bimface.com/data/v2/query/elementIds
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Body

dsl
必填

查询DSL

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/query/elementIds
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{ }
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "elementIds" : [ "313047", "313048", "313049", "313050", "313088", "313116", "313153", "313154", "313155", "313156", "313209", "313253" ],
    "targetId" : "1373177833349216"
  } ],
  "message" : ""
}

查询指定模型构件属性的所有可能值

GET https://api.bimface.com/data/v2/query/propertyValues
说明

为同时支持单模型和集成模型,目标类型有两个可选值:file, integration

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Query

properties
必填

需要查询的属性列表

< string > array(multi)

Query

targetIds
必填

目标ID

< string > array(multi)

Query

targetType
必填

目标类型

string

"file"

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/query/propertyValues?properties=string&targetIds=string&targetType=file
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "property" : "floor",
    "values" : [ "-2.45", "0.0" ]
  } ],
  "message" : ""
}

查询符合条件的面积分区ID列表

GET https://api.bimface.com/data/v2/query/areaIds
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Body

dsl
必填

查询DSL

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/query/areaIds
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{ }
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "areaIds" : [ "313464", "313467", "313470", "313473" ],
    "targetId" : "73c94d28911743c681a89ea38f4543c0"
  } ],
  "message" : ""
}

查询符合条件的房间ID列表

GET https://api.bimface.com/data/v2/query/roomIds
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Body

dsl
必填

查询DSL

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/query/roomIds
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{ }
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "roomIds" : [ "313128", "313131", "313134", "313137" ],
    "targetId" : "24bdf29ab41c41308520dc684e14630e"
  } ],
  "message" : ""
}

构件空间关系计算

在进行BIM应用的时候,经常需要计算某个房间与构件之间的空间关系,比如某个房间内包含的构件,或者某个构件属于哪个房间。而这些信息,在原始的模型文件里是不存在。 幸运的是,BIMFACE利用强大的云计算能力,提供了实时计算空间关系的API, 助力BIM深度应用。

参数 roomToleranceZ 说明

默认值:STRICT

STRICT:element的Z坐标范围严格包含在room的Z坐标范围内

ORDINARY:element的Z坐标端点和中点共三个点,至少有两个点包含在room的Z坐标范围内

LENIENT:element的Z坐标端点和中点共三个点,至少有一个点包含在room的Z坐标范围内

如下图:黑色线表示room的Z轴范围,红色线表示element的Z轴范围,蓝色点红色线的中点,每张图下面注明了哪些参数认定此情况room包含了element。

roomToleranceZ

参数 roomToleranceXY 说明

默认值:ORDINARY

STRICT:element的XY平面四个顶点都在room的boundary里面

ORDINARY:element的XY平面四个顶点和一个中心点共五个点,有三个包含在room的boundary里面

LENIENT:element的XY平面四个顶点和一个中心点共五个点,有一个包含在room的boundary里面

如下图:黑色多边形表示room的boundary,红色矩形表示element的BoundingBox在XY平面的投影,蓝色点表示红色矩形的中心点,每张图下面注明了哪些参数认定此情况room包含了element。

roomToleranceXY

获取楼层对应房间列表

GET https://api.bimface.com/data/v2/files/{fileId}/rooms
说明

当前支持两种方式查询房间列表:1)使用楼层ID查询属于给定楼层的房间列表 2)使用构件ID在空间中计算查询包含该构件的房间列表,这两种方式只能取其一,楼层ID优先。

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Path

fileId
必填

文件ID

integer (int64)

Query

elementId
可选

构件ID

string

Query

floorId
可选

楼层ID

string

Query

roomToleranceXY
可选

XY方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"ORDINARY"

Query

roomToleranceZ
可选

Z方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"STRICT"

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/rooms
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "area" : 7.256476003661832E7,
    "bboxMax" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "bboxMin" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 40087.80000000279,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  } ],
  "message" : ""
}

根据给定的楼层ID或构件ID获取对应房间列表

GET https://api.bimface.com/data/v2/integrations/{integrateId}/rooms
说明

当前支持两种方式查询房间列表:1)使用楼层ID查询属于给定楼层的房间列表 2)使用构件ID在空间中计算查询包含该构件的房间列表,这两种方式只能取其一,楼层ID优先。

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成ID

integer (int64)

Query

elementId
可选

构件ID

string

Query

floorId
可选

楼层ID

string

Query

roomToleranceXY
可选

XY方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"ORDINARY"

Query

roomToleranceZ
可选

Z方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"STRICT"

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1384705681529024/rooms
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "area" : 7.256476003661832E7,
    "bboxMax" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "bboxMin" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 40087.80000000279,
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  } ],
  "message" : ""
}

转换/集成/对比数据包相关

当模型转换/集成/对比成果执行后,都会在服务器端生成一个对应的数据包,这个数据包里包含了转换的部分结果,特别是显示数据。不同的转换类型(如rvt文件转换)会产生不同的结果文件。 为方便开发者直接获取数据包内部的信息,提供了如下的数据包相关的API:

获取数据包大小

GET https://api.bimface.com/data/databag/length
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileId
必填

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/databag/length?fileId=1349283668249920
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "length" : 0
  },
  "message" : ""
}

获取缩略图链接

GET https://api.bimface.com/data/v2/databag/thumbnail
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileId
必填

文件ID

integer (int64)

Query

size
必填

缩略图大小

integer (int32)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/databag/thumbnail?fileId=1349283668249920&size=96
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

获取dwg模型zip包下载地址

GET https://api.bimface.com/data/databag/dwg
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

fileId
可选

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/databag/dwg
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "message" : "string",
  "data" : "http://m.bimface.com/xxx.zip"
}

获取数据包内PDF文件链接

GET https://api.bimface.com/data/v2/databag/pdf
说明

当前仅支持DWG图纸

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

dwgFileId
必填

DWG文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/databag/pdf?dwgFileId=1349283668249920
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

获取指定布局的预览图片链接

GET https://api.bimface.com/data/v2/databag/previewImage
说明

当前仅支持DWG图纸

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

dwgFileId
必填

DWG文件ID

integer (int64)

Query

layoutName
必填

layout名字

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/databag/previewImage?dwgFileId=1349283668249920&layoutName=布局1_4028
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

离线数据包相关

由于用户所在环境以及应用开发自身的需求,BIMFACE的用户可能想在如下两个场景下还能浏览上传的BIMFACE的模型:

  • 由于内容保护等原因,有些BIMFACE的用户所在的网络环境不一定允许访问公网的BIMFACE服务.

  • 用户自己的应用服务不想依赖于BIMFACE的服务来浏览已经在BIMFACE转换过的模型

离线数据包功能就是为这种需求量身设计的,每一个用户上传的模型在转换后都可以生成对应的离线数据包, 该离线数据包可以下载到本地,独立部署到用户的环境内,具体操作流程以及部署细节可以参考BIMFACE开发指南

通过传入相应的ID创建对应离线数据包:
文件转换ID:PUT  https://api.bimface.com/files/{fileId}/offlineDatabag?callback={callback}
集成模型ID:PUT  https://api.bimface.com/integrations/{integrateId}/offlineDatabag?callback={callback}
模型对比ID:PUT  https://api.bimface.com/comparisions/{compareId}/offlineDatabag?callback={callback}
文件转换、集成或对比成功后,即可创建该文件的离线数据包。

文件ID创建离线数据包

PUT https://api.bimface.com/files/{fileId}/offlineDatabag
说明

通过文件ID创建离线数据包

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Path

fileId
必填

通过文件ID创建离线数据包

integer (int64)

Query

callback
必填

回调url

string

Body

request
必填

DatabagDerivativeRequest请求体

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/files/1199714943746080/offlineDatabag?callback=https://api.glodon.com/viewing/callback%3FauthCode%3DBJ90Jk0affae%26signature%3D2ef131395fb6442eb99abd83d45c2412
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "config" : {
    "string" : "string"
  }
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2018-03-29 18:26:01",
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  },
  "message" : ""
}
响应 200
{
    "code": "success",
    "message": "",
    "data": {
        "fileId": 8167234891,
        "databagVersion": "2.0",
        "status": "processing",
        "reason": null,
        "createTime":"2016-08-08 12:36:47"
    }
}
返回体参数说明
字段 类型 描述 示例

fileId

Long

文件转换Id

8167234891

databagVersion

String

离线包版本

2.0

status

String

离线包状态

processing(生成中)、success(生成成功)、failed(生成失败)

reason

String

若生成失败,返回失败原因

createTime

String

离线包生成时间

2016-08-08 12:36:47

失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

file.not.found

文件不存在

file.not.translated

文件没有发起转换,不能生成离线包

file.translating

文件正在转换中,不能生成离线包

file.translate.failure

文件转换失败,不能生成离线包


回调(Callback)
待离线包生成后,根据调用方传入的回调地址,BIMFACE会通知结果。
HTTP 方法

GET

Header
key value 示例

Content-Type

application/json

Url 参数
字段 类型 描述 示例

fileId

Number

文件ID

85929027838566

status

String

转换状态,processing-进行中,success-完成,failed-失败

reason

String

若集成失败,则返回失败原因

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFACE发出的,调用方在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:fileId:status:nonce''),如果调用方计算的签名与BIMFACE返回的签名一致,则证明该消息是安全可靠的。

文件集成ID创建离线数据包

PUT https://api.bimface.com/integrations/{integrateId}/offlineDatabag
说明

通过文件集成ID创建离线数据包

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Path

integrateId
必填

通过集成模型ID创建离线数据包

integer (int64)

Query

callback
必填

回调url

string

Body

request
必填

DatabagDerivativeRequest请求体

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrations/1199714943746080/offlineDatabag?callback=https://api.glodon.com/viewing/callback%3FauthCode%3DBJ90Jk0affae%26signature%3D2ef131395fb6442eb99abd83d45c2412
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "config" : {
    "string" : "string"
  }
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2018-03-29 18:26:01",
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  },
  "message" : ""
}
响应 200
{
    "code": "success",
    "message": "",
    "data": {
        "integrateId": 8167234891,
        "databagVersion": "2.0",
        "status": "processing",
        "reason": null,
        "createTime":"2016-08-08 12:36:47"
    }
}
返回体参数说明
字段 类型 描述 示例

integrateId

Long

集成模型ID

8167234891

databagVersion

String

离线包版本

2.0

status

String

离线包状态

processing(生成中)、success(生成成功)、failed(生成失败)

reason

String

若生成失败,返回失败原因

createTime

String

离线包生成时间

2016-08-08 12:36:47

失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

integration.not.found

集成模型未找到

integration.not.translated

模型未集成,不能生成离线包

integration.translating

模型正在集成中,不能生成离线包

integration.translate.failure

模型集成失败,不能生成离线包


回调(Callback)
待离线包生成后,根据调用方传入的回调地址,BIMFACE会通知结果。
HTTP 方法

GET

Header
key value 示例

Content-Type

application/json

Url 参数
字段 类型 描述 示例

integrateId

Number

集成模型ID

85929027838566

status

String

转换状态,processing-进行中,success-完成,failed-失败

reason

String

若集成失败,则返回失败原因

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFACE发出的,调用方在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:integrateId:status:nonce''),如果调用方计算的签名与BIMFACE返回的签名一致,则证明该消息是安全可靠的。

模型对比ID创建离线数据包

PUT https://api.bimface.com/comparisions/{compareId}/offlineDatabag
说明

通过模型对比ID创建离线数据包

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Path

compareId
必填

通过模型对比ID创建离线数据包

integer (int64)

Query

callback
必填

回调url

string

Body

request
必填

DatabagDerivativeRequest请求体

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/comparisions/1199714943746080/offlineDatabag?callback=https://api.glodon.com/viewing/callback%3FauthCode%3DBJ90Jk0affae%26signature%3D2ef131395fb6442eb99abd83d45c2412
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "config" : {
    "string" : "string"
  }
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2018-03-29 18:26:01",
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  },
  "message" : ""
}
响应 200
{
    "code": "success",
    "message": "",
    "data": {
        "compareId": 8167234891,
        "databagVersion": "2.0",
        "status": "processing",
        "reason": null,
        "createTime":"2016-08-08 12:36:47"
    }
}
返回体参数说明
字段 类型 描述 示例

compareId

Long

对比模型ID

8167234891

databagVersion

String

离线包版本

2.0

status

String

离线包状态

processing(生成中)、success(生成成功)、failed(生成失败)

reason

String

若生成失败,返回失败原因

createTime

String

离线包生成时间

2016-08-08 12:36:47

失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

compare.not.found

对比文件未找到

compare.not.translated

对比文件没有转换,不能生成离线包

compare.translating

对比文件转换中,不能生成离线包

compare.translate.failure

对比文件转换失败,不能生成离线包


回调(Callback)
待离线包生成后,根据调用方传入的回调地址,BIMFACE会通知结果。
HTTP 方法

GET

Header
key value 示例

Content-Type

application/json

Url 参数
字段 类型 描述 示例

compareId

Number

集成模型ID

85929027838566

status

String

转换状态,processing-进行中,success-完成,failed-失败

reason

String

若集成失败,则返回失败原因

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFACE发出的,调用方在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:compareId:status:nonce''),如果调用方计算的签名与BIMFACE返回的签名一致,则证明该消息是安全可靠的。

查询文件离线数据包

GET https://api.bimface.com/files/{fileId}/offlineDatabag
说明

通过文件ID查询离线数据包

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Path

fileId
必填

通过文件ID查询离线数据包

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/files/1199714943746080/offlineDatabag
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "createTime" : "2018-03-29 18:26:01",
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  } ],
  "message" : ""
}

查询模型对比离线数据包

GET https://api.bimface.com/comparisions/{compareId}/offlineDatabag
说明

通过模型对比ID查询离线数据包

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Path

compareId
必填

通过模型对比ID查询离线数据包

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/comparisions/1199714943746080/offlineDatabag
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "createTime" : "2018-03-29 18:26:01",
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  } ],
  "message" : ""
}

查询集成模型离线数据包

GET https://api.bimface.com/integrations/{integrateId}/offlineDatabag
说明

通过集成模型ID查询离线数据包

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Path

integrateId
必填

通过集成模型ID查询离线数据包

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrations/1199714943746080/offlineDatabag
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "createTime" : "2018-03-29 18:26:01",
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  } ],
  "message" : ""
}

获取数据包下载地址

GET https://api.bimface.com/data/databag/downloadUrl
说明

支持获取单模型,集成模型,模型对比的离线数据包,请求参数必须根据模型类型指定文件ID,集成ID或对比ID。如果都为空,则报错。

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Query

compareId
可选

模型对比ID

integer (int64)

Query

databagVersion
可选

数据包版本;对于offline、vr数据包,如果只有一个,则下载唯一的数据包,如果多个,则必须指定数据包版本

string

Query

fileId
可选

代表单模型的文件ID

integer (int64)

Query

integrateId
可选

集成模型ID

integer (int64)

Query

type
可选

数据包类型,如offline、vr、igms

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/databag/downloadUrl
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "message" : "string",
  "data" : "http://m.bimface.com/xxx.zip"
}

双向业务挂接

第三方应用在与BIMFACE数据进行集成的时候,一个通用的需求,就是要把一些应用中的业务实体对象(如任务, 质量安全检查点, 问题隐患等等)与模型中的构件进行双向挂接,“双向”指的是在单模型或集成模型中,可以:

  1. 从构件Id查询与之关联的所有业务实体Id(待补充)。

  2. 从业务实体对象Id查询与之关联的所有构。

BIMFACE为支持百亿级别的构件数量,采用了列存储数据库(一种用于保存半结构化数据的NoSQL数据库,可支持TB级别的数据高效存储与检索)来保存构件相关的各种数据。

如果第三方应用在自己的关系型数据库(如MySQL,SQLServer)中来记录业务实体与构件之间的双向关系,随着数据量的增多,对数据库的性能势必会造成压力,并且需要更高配的数据库。双向业务挂接API解决了这个问题。第三方应用可以把业务实体对象的Id与对应构件Id的关系直接存储在BIMFACE, 并且提供了两个字段(业务类型/businessType, 业务标志/businessFlag)给业务实体进行扩展; 查询方面,按照前面表述的,从业务实体Id查构件,以及从构件Id查相关业务实体都是支持的,而且由于使用的是列存储数据库,API的调用时延是非常低的。

创建/新增集成模型的双向业务挂接

POST https://api.bimface.com/data/v2/integrations/{integrateId}/associations
说明

支持两种方式创建双向业务挂接:1)在请求体中指定需要新增的挂接。2)从指定的其他集成模型中拷贝,此场景非常适合多个模型不同版本多次进行集成时候来保持挂接关系。如果请求体内包含的业务挂接项不为空,则认为是新增业务挂接项;反之,且源集成模型Id不为空,则认为是从源集成模型拷贝业务挂项。另外,如果"拷贝源业务类型"和"拷贝源业务标志"为空,则默认拷贝源集成模型上的所有业务挂接项

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成模型ID

string

Query

fromBusinessFlag
可选

拷贝源业务标志, 若不指定,则指拷贝所有业务挂接标志

string

Query

fromBusinessType
可选

拷贝源业务类型,若不指定,则指拷贝所有业务挂接类型

string

Query

fromIntegrationId
可选

拷贝源集成模型ID

string

Body

request
可选

新增双向业务挂接项

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/associations
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "associations" : [ {
    "businessFlag" : "flag_test",
    "businessId" : "1299507310231776",
    "businessType" : "type_test",
    "elementId" : "12321"
  } ],
  "businessFlag" : "flag_test",
  "businessType" : "type_test"
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

根据业务实体ID查询与之关联的业务挂接项列表(含构件ID列表)

GET https://api.bimface.com/data/v2/integrations/{integrateId}/businessTypes/{businessType}/businesses/{businessId}/associations
说明

可以指定对应的"业务挂接类型"来缩小范围

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

businessId
必填

业务ID

string

Path

businessType
必填

业务挂接类型,若不指定,则指所有业务挂接类型

string

Path

integrateId
必填

集成模型ID

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/businessTypes/type_test/businesses/1299507310231776/associations
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "businessFlag" : "flag_test",
    "businessId" : "1299507310231776",
    "businessType" : "type_test",
    "elementIds" : [ "12321" ],
    "integrateId" : "1299498154893536"
  } ],
  "message" : ""
}

根据构件ID查询与之关联的业务挂接

GET https://api.bimface.com/data/v2/integrations/{integrateId}/elements/{elementId}/associations
说明

可以指定对应的业务挂接类型"和"业务挂接标志"来缩小返回的业务挂接范围。

参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

构件ID

string

Path

integrateId
必填

集成模型ID

string

Query

businessFlag
可选

业务挂接标志, 若不指定,则指所有业务挂接标志

string

Query

businessType
可选

业务挂接类型,若不指定,则指所有业务挂接类型

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/elements/12321/associations
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "businessFlag" : "flag_test",
    "businessIds" : [ "1299507310231776" ],
    "businessType" : "type_test",
    "elementId" : "12321",
    "integrateId" : "1299498154893536"
  } ],
  "message" : ""
}

删除业务挂接

DELETE https://api.bimface.com/data/v2/integrations/{integrateId}/associations/biz
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成模型ID

string

Query

businessFlag
可选

业务挂接标志, 若不指定,则指所有业务挂接标志

string

Query

businessIds
可选

业务ID集合, 若不指定,则指所有

< string > array(multi)

Query

businessType
可选

业务挂接类型, 若不指定,则指所有业务挂接类型

string

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/associations/biz
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

删除业务实体关联的业务挂接

DELETE https://api.bimface.com/data/v2/integrations/{integrateId}/businessTypes/{businessType}/businesses/{businessId}/associations
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

businessId
必填

业务实体ID

string

Path

businessType
必填

业务挂接类型

string

Path

integrateId
必填

集成模型ID

string

Query

elementIds
可选

构件ID集合, 若不指定,则指所有

< string > array(multi)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/businessTypes/type_test/businesses/1299507310231776/associations
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

删除构件关联的业务挂接

DELETE https://api.bimface.com/data/v2/integrations/{integrateId}/elements/{elementId}/associations
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

elementId
必填

构件ID

string

Path

integrateId
必填

集成模型ID

string

Query

businessFlag
可选

业务挂接标志, 若不指定,则指所有业务挂接标志

string

Query

businessIds
可选

业务ID集合, 若不指定,则指所有

< string > array(multi)

Query

businessType
可选

业务挂接类型, 若不指定,则指所有业务挂接类型

string

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/elements/12321/associations
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

删除业务挂接

DELETE https://api.bimface.com/data/v2/integrations/{integrateId}/associations/element
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

integrateId
必填

集成模型ID

string

Query

businessFlag
可选

业务挂接标志, 若不指定,则指所有业务挂接标志

string

Query

businessType
可选

业务挂接类型, 若不指定,则指所有业务挂接类型

string

Query

elementIds
可选

构件ID集合, 若不指定,则指所有

< string > array(multi)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1299498154893536/associations/element
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

rfa构件数据

rfa文件族类型属性key列表

GET https://api.bimface.com/data/v2/rfaFiles/{rfaFileId}/propertyNames
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

rfaFileId
可选

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/rfaFiles/1098654196286240/propertyNames
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ "string" ],
  "message" : ""
}

rfa文件族类型属性列表

GET https://api.bimface.com/data/v2/rfaFiles/{rfaFileId}/familyTypes/{familyTypeGuid}
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

familyTypeGuid
可选

族类型guid

string

Path

rfaFileId
可选

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/rfaFiles/1098654196286240/familyTypes/f1a75aa9-d417-46a1-806d-bc4058583821
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "familyTypeId" : "cfd78ac2-7b11-4a72-8ceb-04335916be57",
    "name" : "1200 x 2100mm",
    "properties" : [ {
      "group" : "basic property",
      "items" : [ {
        "code" : "SectionHeight",
        "extension" : "object",
        "key" : "specialty",
        "unit" : "mm",
        "value" : "not specified",
        "valueType" : 1
      } ]
    } ]
  },
  "message" : ""
}

rfa文件族类型列表

GET https://api.bimface.com/data/v2/rfaFiles/{rfaFileId}/familyTypeMetas
参数
类型 名称 说明 类型

Header

Authorization
必填

authorization header

string

Path

rfaFileId
可选

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/rfaFiles/1098654196286240/familyTypeMetas
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "familyTypeGuid" : "cfd78ac2-7b11-4a72-8ceb-04335916be57",
    "name" : "1200 x 2100mm"
  } ],
  "message" : ""
}

分享链接相关

生成分享链接

POST https://api.bimface.com/share
说明

文件发起转换以后,可以根据fileId生成该文件的分享链接;或者发起集成模型以后,可以根据integrateId生成集成模型的分享链接

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

activeHours
可选

有效时长,单位:小时,如果不设置表示永久有效

integer (int32)

Query

expireDate
可选

有效期限,单位:精确到天,如果不设置表示永久有效

string

Query

fileId
可选

文件ID(集成ID二选一)

integer (int64)

Query

integrateId
可选

集成ID(文件ID二选一)

integer (int64)

Query

needPassword
可选

分享链接是否生成访问密码

boolean

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/share
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appKey" : "appKey",
    "expireTime" : "2018-11-30 00:00:00",
    "password" : "sdfgth",
    "sourceId" : 1234567890987,
    "sourceName" : "1206075470044992",
    "sourceType" : "1",
    "url" : "https://api.bimface.com/preview/e41f2092"
  },
  "message" : ""
}

显示分享列表

GET https://api.bimface.com/shares
说明

Appkey下显示所有的分享列表

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/shares
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "appKey" : "appKey",
    "expireTime" : "2018-11-30 00:00:00",
    "password" : "sdfgth",
    "sourceId" : 1234567890987,
    "sourceName" : "1206075470044992",
    "sourceType" : "1",
    "url" : "https://api.bimface.com/preview/e41f2092"
  } ],
  "message" : ""
}

取消分享链接

DELETE https://api.bimface.com/share
说明

若不希望继续分享,可以根据fileId或integrateId取消对应的分享链接,使之失效

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

fileId
可选

文件ID(集成ID二选一)

integer (int64)

Query

integrateId
可选

集成ID(文件ID二选一)

integer (int64)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/share
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

批量取消分享链接

DELETE https://api.bimface.com/shares
说明

若不希望继续分享,可以根据sourceId批量取消对应的分享链接,使之失效

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

sourceIds
可选

sourceIds

< integer (int64) > array(multi)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/shares
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

获取分享链接信息

GET https://api.bimface.com/share
说明

获取分享链接信息,包括有效期、访问密码、访问地址

参数
类型 名称 说明 类型

Header

Authorization
必填

认证信息头

string

Query

fileId
可选

文件ID

integer (int64)

Query

integrateId
可选

集成ID

integer (int64)

Query

token
可选

token

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/share
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appKey" : "appKey",
    "expireTime" : "2018-11-30 00:00:00",
    "password" : "sdfgth",
    "sourceId" : 1234567890987,
    "sourceName" : "1206075470044992",
    "sourceType" : "1",
    "url" : "https://api.bimface.com/preview/e41f2092"
  },
  "message" : ""
}

数据实体类

AccessTokenBean

名称 说明 类型

expireTime
可选

样例 : "2018-11-21 18:33:44"

string

token
可选

样例 : "ab00e0b4-0db0-4554-a7a7-b6a274588816"

string

BusinessAssociationBean

名称 说明 类型

associationId
可选

样例 : 1469060916315200

integer (int64)

config
可选

样例 : "object"

object

createTime
可选

样例 : "2018-11-01 22:27:47"

string

integrateId
可选

样例 : 133542854

integer (int64)

name
可选

样例 : "quality-std-assoc-1469060328809536"

string

priority
可选

最小值 : -128
最大值 : 127
样例 : 2

integer (int32)

reason
可选

样例 : "reason"

string

ruleFileIds
可选

样例 : [ 0 ]

< integer (int64) > array

sourceId
可选

样例 : "1469060916315200"

string

status
可选

样例 : "success"

string

BusinessAssociationRequest

名称 说明 类型

callback
可选

样例 : "http://192.168.73.28:8080/association/jobs/186/tasks/203/completion/passthru"

string

config
可选

样例 : "object"

object

integrateId
可选

样例 : 133542854

integer (int64)

name
可选

样例 : "purchaseProduct222230"

string

priority
可选

最小值 : -128
最大值 : 127
样例 : 2

integer (int32)

ruleFileIds
可选

样例 : [ 1223122 ]

< object > array

sourceId
可选

样例 : "1469060916315200"

string

CompareRequest

名称 说明 类型

callback
可选

样例 : "https://api.glodon.com/viewing/callback?authCode=BJ90Jk0affae&signature=2ef131395fb6442eb99abd83d45c2412"

string

comparedEntityType
可选

样例 : "file"

string

config
可选

样例 : "object"

object

followingId
可选

样例 : 22145522

integer (int64)

name
可选

样例 : "compare0001"

string

previousId
可选

样例 : 12311221

integer (int64)

priority
可选

样例 : 2

integer (int32)

sourceId
可选

样例 : "123223223212"

string

DatabagDerivativeBean

名称 说明 类型

createTime
可选

样例 : "2018-03-29 18:26:01"

string

databagVersion
可选

样例 : "3.1"

string

length
可选

样例 : 0

integer (int64)

reason
可选

样例 : "reason"

string

status
可选

样例 : "success"

string

DatabagDerivativeRequest

名称 说明 类型

config
可选

样例 : { "string" : "string" }

< string, string > map

Diff

名称 说明 类型

next
可选

样例 : 0

integer (int64)

prev
可选

样例 : 0

integer (int64)

ElementPropertyOverride

名称 说明 类型

keyToMatch
可选

样例 : "system_type"

string

keyToOverride
可选

样例 : "specialty"

string

targetFileIds
可选

样例 : [ "1468861829161440", "1468862035943904" ]

< object > array

valueOverrides
可选

ElementPropertyValueOverride

名称 说明 类型

valueToMatch
可选

样例 : "water_support_pipe"

string

valueToOverride
可选

样例 : "water_support"

string

FileIntegrateBean

名称 说明 类型

createTime
可选

样例 : "2017-12-25 17:25:25"

string

integrateId
可选

样例 : 1248789977538784

integer (int64)

name
可选

样例 : "integrate-x"

string

priority
可选

样例 : 2

integer (int32)

reason
可选

样例 : "reason"

string

sourceId
可选

样例 : "123156522123"

string

status
可选

样例 : "success"

string

thumbnail
可选

样例 : [ "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/96.png", "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/256.png" ]

< object > array

FileIntegrateRequest

名称 说明 类型

callback
可选

样例 : "https://api.glodon.com/viewing/callback?authCode=6kj0Jk0affae&signature=2ef131395fb6442eb99abd83d45c6016"

string

config
可选

样例 : "config"

string

floorMapping
可选

样例 : [ "FloorMappingItem" ]

< FloorMappingItem > array

floorSort
可选

样例 : [ "5" ]

< string > array

internalConfigMap
可选

样例 : { "string" : "string" }

< string, string > map

name
可选

样例 : "model.rvt"

string

parentIntegrateId
可选

样例 : 0

integer (int64)

priority
可选

样例 : 2

integer (int32)

propertyOverrides
可选

样例 : [ "ElementPropertyOverride" ]

ruleFileIds
可选

样例 : [ 1232134213412 ]

< object > array

sourceId
可选

样例 : "hduf2w3ho21nowr23rqwjrn2o3"

string

sources
可选

样例 : [ "IntegrateSource" ]

< IntegrateSource > array

specialtySort
可选

样例 : [ "2" ]

< string > array

FileTranslateBean

名称 说明 类型

createTime
可选

样例 : "2017-12-25 17:23:46"

string

databagId
可选

样例 : "9b711803a43b92d871cde346b63e5019"

string

fileId
可选

样例 : 1248789071339712

integer (int64)

name
可选

样例 : "bimface_2018.rvt"

string

priority
可选

样例 : 2

integer (int32)

reason
可选

样例 : "reason"

string

status
可选

样例 : "success"

string

thumbnail
可选

样例 : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png", "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/256.png" ]

< object > array

FileTranslateRequest

名称 说明 类型

callback
可选

样例 : "https://api.glodon.com/viewing/callback?authCode=iklJk0affae&signature=2ef131395fb6442eb99abd83d45c3201"

string

config
可选

样例 : { "string" : "string" }

< string, string > map

priority
可选

样例 : 2

integer (int32)

source
可选

样例 : TranslateSource

FloorMappingItem

名称 说明 类型

fileFloorId
可选

样例 : "pj1101"

string

projectFloorId
可选

样例 : "pj11"

string

projectFloorName
可选

样例 : "firstfloor"

string

GeneralResponse

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«AccessTokenBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : AccessTokenBean

message
可选

样例 : ""

string

GeneralResponse«BusinessAssociationBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«DatabagDerivativeBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«FileIntegrateBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«FileTranslateBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«InsecureShareLinkBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«DatabagDerivativeBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DatabagDerivativeBean" ]

message
可选

样例 : ""

string

GeneralResponse«List«ProjectIntegrateBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ProjectIntegrateBean" ]

message
可选

样例 : ""

string

GeneralResponse«List«ProjectOperationBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ProjectOperationBean" ]

message
可选

样例 : ""

string

GeneralResponse«List«ShareLinkBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ShareLinkBean" ]

< ShareLinkBean > array

message
可选

样例 : ""

string

GeneralResponse«ModelCompareBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ModelCompareBean

message
可选

样例 : ""

string

GeneralResponse«ModelVersionInfo»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ModelVersionInfo

message
可选

样例 : ""

string

GeneralResponse«ProjectBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ProjectBean

message
可选

样例 : ""

string

GeneralResponse«ShareLinkBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ShareLinkBean

message
可选

样例 : ""

string

GeneralResponse«boolean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : true

boolean

message
可选

样例 : ""

string

GeneralResponse«string»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "data"

string

message
可选

样例 : ""

string

InsecureShareLinkBean

名称 说明 类型

appKey
可选

样例 : "appKey"

string

expireTime
可选

样例 : "expireTime"

string

passwordProtect
可选

样例 : true

boolean

sourceId
可选

样例 : 0

integer (int64)

sourceType
可选

样例 : "sourceType"

string

url
可选

样例 : "url"

string

IntegrateSource

名称 说明 类型

building
可选

样例 : "GlodonBuilding"

string

databagId
可选

样例 : "h2h2312223"

string

fileId
可选

样例 : 12311221

integer (int64)

fileName
可选

样例 : "model.rvt"

string

floor
可选

样例 : "F01"

string

floorSort
可选

样例 : 0.1

number (float)

specialty
可选

样例 : "AR"

string

specialtySort
可选

样例 : 0.1

number (float)

transform
可选

样例 : [ 1.23 ]

< number (double) > array

ModelAndView

名称 说明 类型

empty
可选

样例 : true

boolean

model
可选

样例 : "object"

object

modelMap
可选

样例 : { "string" : "object" }

< string, object > map

reference
可选

样例 : true

boolean

status
可选

样例 : "string"

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

view
可选

样例 : View

viewName
可选

样例 : "string"

string

ModelCompareBean

名称 说明 类型

compareId
可选

样例 : 1248756572307264

integer (int64)

createTime
可选

样例 : "2017-12-25 16:17:27"

string

name
可选

样例 : "compare0001"

string

priority
可选

最小值 : -128
最大值 : 127
样例 : 2

integer (int32)

reason
可选

样例 : "reason"

string

sourceId
可选

样例 : "123223223212"

string

status
可选

样例 : "succcess"

string

thumbnail
可选

样例 : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png" ]

< object > array

ModelCompareItem

名称 说明 类型

followingDatabagId
可选

样例 : "f3323ff221"

string

followingFileId
可选

样例 : 22145522

integer (int64)

followingFileName
可选

样例 : "folModel0001"

string

previousDatabagId
可选

样例 : "h2h2312223"

string

previousFileId
可选

样例 : 12311221

integer (int64)

previousFileName
可选

样例 : "preModel0001"

string

ModelCompareRequest

名称 说明 类型

callback
可选

样例 : "https://api.glodon.com/viewing/callback?authCode=BJ90Jk0affae&signature=2ef131395fb6442eb99abd83d45c2412"

string

name
可选

样例 : "compare0001"

string

priority
可选

样例 : "2;"

integer (int32)

sourceId
可选

样例 : "123223223212"

string

sources
可选

样例 : [ "ModelCompareItem" ]

< ModelCompareItem > array

ModelVersionInfo

名称 说明 类型

config
可选

样例 : { "string" : "string" }

< string, string > map

databagId
可选

样例 : "8636a4058e7aaea4dfa4ecd769c9e44a"

string

isSupportComponentProperty
可选

样例 : false

boolean

isSupportDrawing
可选

样例 : false

boolean

isSupportFamilyTypeList
可选

样例 : false

boolean

isSupportMaterialProperty
可选

样例 : false

boolean

isSupportMiniMap
可选

样例 : false

boolean

isSupportModelTree
可选

样例 : false

boolean

isSupportRoomArea
可选

样例 : false

boolean

isSupportWalk
可选

样例 : true

boolean

jsSDKVersion
可选

样例 : "Drawing@1.4.21"

string

modelId
可选

样例 : 1442677445091680

integer (int64)

modelType
可选

样例 : "singleModel"

string

name
可选

样例 : "name"

string

renderType
可选

样例 : "drawingView"

string

renderVersion
可选

样例 : "1.0"

string

subRenders
可选

样例 : [ "RenderInfo" ]

< RenderInfo > array

type
可选

最小值 : -128
最大值 : 127
样例 : 1

integer (int32)

workerType
可选

样例 : "dwg-transfer"

string

ProjectBean

名称 说明 类型

createTime
可选

样例 : "2018-11-21 11:09:05"

string

id
可选

样例 : 1482883097924832

integer (int64)

integrateId
可选

样例 : 1482282416739552

integer (int64)

integrateStatus
可选

样例 : "processing"

string

name
可选

样例 : "projectReplaceIntegrateIgms_1542769436014"

string

ProjectCreateRequest

名称 说明 类型

callback
可选

样例 : "callback-project-create"

string

integrate
可选

materialOverrideSetFileId
可选

样例 : 1848927668131

integer (int64)

metaFileId
可选

样例 : 12133321212

integer (int64)

name
可选

样例 : "projectReplaceIntegrateIgms_1542769436014"

string

segmentFileId
可选

样例 : 1947792131

integer (int64)

ProjectIntegrateBean

名称 说明 类型

active
可选

样例 : false

boolean

createTime
可选

样例 : "2018-11-21 11:16:40"

string

integrateId
可选

样例 : 1482886825563360

integer (int64)

parentIntegrateId
可选

样例 : 5632012478745400

integer (int64)

status
可选

样例 : "success"

string

ProjectModifyRequest

名称 说明 类型

addedFileIds
可选

样例 : [ 1741234213423 ]

< object > array

callback
可选

样例 : "callback-project-modify"

string

changedFileIds
可选

样例 : [ "Diff" ]

< Diff > array

deletedFileIds
可选

样例 : [ 17319741934123 ]

< object > array

materialOverrideSetFileId
可选

样例 : 1734092134

integer (int64)

metaFileId
可选

样例 : 2374892141

integer (int64)

segmentFileId
可选

样例 : 1347784336780608

integer (int64)

transformMap
可选

样例 : { "string" : [ 0.0 ] }

< string, < number (double) > array > map

ProjectOperationBean

名称 说明 类型

addedFiles
可选

样例 : ""

string

callbackStatus
可选

样例 : "null"

integer (int32)

callbackTimes
可选

最小值 : -128
最大值 : 127
样例 : 1

integer (int32)

callbackUrl
可选

样例 : "callback-project-operation"

string

changedFiles
可选

样例 : ""

string

createTime
可选

样例 : 1542701893000

integer (int64)

deletedFiles
可选

样例 : ""

string

id
可选

样例 : 1482330998494432

integer (int64)

integrate
可选

样例 : true

boolean

jobId
可选

样例 : 1482331457975328

integer (int64)

jobSourceId
可选

样例 : 1482331455999008

integer (int64)

metaFileId
可选

样例 : 1231231231231230

integer (int64)

mosFileId
可选

样例 : 1000100010001

integer (int64)

projectId
可选

样例 : 1482327255430368

integer (int64)

segmentFileId
可选

样例 : 2000200020002

integer (int64)

status
可选

最小值 : -128
最大值 : 127
样例 : -1

integer (int32)

transform
可选

样例 : "transform"

string

workerCode
可选

样例 : "send.job.failed"

string

workerMessage
可选

样例 : "error: [com.aliyun.oss.ClientException: UnknownHost]"

string

ProjectOperationFixRequest

名称 说明 类型

callback
可选

样例 : "callback-project-fix"

string

replaceFileMap
可选

样例 : { "string" : 0 }

< string, integer (int64) > map

transformMap
可选

样例 : { "string" : [ 0.0 ] }

< string, < number (double) > array > map

RenderInfo

名称 说明 类型

isSupportComponentProperty
可选

样例 : true

boolean

isSupportFamilyTypeList
可选

样例 : true

boolean

isSupportMiniMap
可选

样例 : true

boolean

isSupportModelTree
可选

样例 : true

boolean

jsSDKVersion
可选

样例 : "Drawing@1.3.357"

string

renderType
可选

样例 : "drawingView"

string

renderVersion
可选

样例 : "1.0"

string

ShareLinkBean

名称 说明 类型

appKey
可选

样例 : "appKey"

string

expireTime
可选

样例 : "2018-11-30 00:00:00"

string

password
可选

样例 : "sdfgth"

string

sourceId
可选

样例 : 1234567890987

integer (int64)

sourceName
可选

样例 : "1206075470044992"

string

sourceType
可选

样例 : "1"

string

url
可选

样例 : "https://api.bimface.com/preview/e41f2092"

string

TranslateSource

名称 说明 类型

compressed
可选

样例 : false

boolean

fileId
可选

样例 : 1277823232112

integer (int64)

rootName
可选

样例 : "rootFileName.rvt"

string

View

名称 说明 类型

contentType
可选

样例 : "string"

string

AppendFileBean

名称 说明 类型

appendFileId
可选

样例 : 1216113551663296

integer (int64)

createTime
可选

样例 : "2017-11-09 13:25:03"

string

file
可选

样例 : FileBean

length
可选

样例 : 39044

integer (int64)

name
可选

样例 : "-1F.rvt"

string

position
可选

样例 : 0

integer (int64)

status
可选

样例 : "success"

string

FileBean

名称 说明 类型

createTime
可选

样例 : "2017-11-09 13:25:03"

string

etag
可选

样例 : "19349858cjs98ericu989"

string

fileId
可选

样例 : 1216113551663296

integer (int64)

length
可选

样例 : 39044

integer (int64)

name
可选

样例 : "-1F.rvt"

string

status
可选

样例 : "success"

string

suffix
可选

样例 : "rvt"

string

GeneralResponse

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«AppendFileBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : AppendFileBean

message
可选

样例 : ""

string

GeneralResponse«FileBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : FileBean

message
可选

样例 : ""

string

GeneralResponse«List«FileBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "FileBean" ]

< FileBean > array

message
可选

样例 : ""

string

GeneralResponse«SupportFileBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : SupportFileBean

message
可选

样例 : ""

string

GeneralResponse«UploadPolicyBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : UploadPolicyBean

message
可选

样例 : ""

string

GeneralResponse«string»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "data"

string

message
可选

样例 : ""

string

SupportFileBean

名称 说明 类型

length
可选

样例 : 1073741824

integer (int64)

types
可选

样例 : [ "rvt", "rfa", "dwg", "dxf", "skp", "ifc", "dgn", "obj", "stl", "3ds", "dae", "ply", "igms", "zip", "gtj", "bfcatzip" ]

< object > array

UploadPolicyBean

名称 说明 类型

accessId
可选

样例 : "QLYNXu7B9OTjErYR"

string

callbackBody
可选

样例 : "eyJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24veC13d3ctZm9ybS11cmxlbmNvZGVkIiwiY2FsbGJhY2tIb3N0IjoiZmlsZS5iaW1mYWNlLmNvbSIsImNhbGxiYWNrVXJsIjoiaHR0cHM6Ly8xMTYuMjI4LjE5NS4xOC9vc3MvcmVjZWl2ZSIsImNhbGxiYWNrQm9keSI6Im9iamVjdD0ke29iamVjdH0mc2l6ZT0ke3NpemV9JmV0YWc9JHtldGFnfSZuYW1lPXRlc3QucGRmJmZpbGVJZD0xNDgzMDY1NTc0NzU0NTI4JmFwcGtleT1hRGxQZjEzVXRpR3M3eXVIQ2Q4ZUhTTEhiSEpUVThTZCZzb3VyY2VJZD0mZmlsZUJ1Y2tldD1iZi1kZXYtc3JjZmlsZSJ9"

string

expire
可选

样例 : 1542792319

integer (int64)

host
可选

样例 : "https://bf-dev-srcfile.oss-cn-shanghai.aliyuncs.com"

string

objectKey
可选

样例 : "2f15df1c430b4ad3b0644029111b703a"

string

policy
可选

样例 : "eyJleHBpcmF0aW9uIjoiMjAxOC0xMS0yMVQwOToyNToxOS45OTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXV19"

string

signature
可选

样例 : "q4NrZ1By/msuHOHlgpgX56mMUhY="

string

sourceId
可选

样例 : "b5046ca25c2748d2922757e749f3df61"

string

Area

名称 说明 类型

area
可选

样例 : 5.168684733047761E7

number (double)

boundary
可选

样例 : ""

string

id
可选

样例 : "313137"

string

levelId
可选

样例 : "11"

string

maxPt
可选

样例 : Coordinate

minPt
可选

样例 : Coordinate

name
可选

样例 : "dining room 4"

string

perimeter
可选

样例 : 28802.013920728663

number (double)

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

viewName
可选

样例 : "1 1"

string

Attribute

名称 说明 类型

key
可选

样例 : "key"

string

unit
可选

样例 : "unit"

string

value
可选

样例 : "value"

string

BarQuantityItem

名称 说明 类型

desc
可选

样例 : "desc"

string

name
可选

样例 : "name"

string

quantity
可选

样例 : 0.0

number (float)

BarQuantityVO

名称 说明 类型

barQuantities
可选

样例 : [ "BarQuantityItem" ]

< BarQuantityItem > array

elementId
可选

样例 : "1873264"

string

floor
可选

样例 : "floor"

string

floorId
可选

样例 : "3b3fd891c8844eafbcf3c015f830118b"

string

name
可选

样例 : "name"

string

BoundingBox

名称 说明 类型

max
可选

样例 : Coordinate

min
可选

样例 : Coordinate

BusinessAssociation

名称 说明 类型

businessFlag
可选

样例 : "flag_test"

string

businessId
可选

样例 : "1299507310231776"

string

businessType
可选

样例 : "type_test"

string

elementId
可选

样例 : "12321"

string

BusinessAssociationRequest

名称 说明 类型

associations
可选

样例 : [ "BusinessAssociation" ]

businessFlag
可选

样例 : "flag_test"

string

businessType
可选

样例 : "type_test"

string

BusinessElementAssociation

名称 说明 类型

businessFlag
可选

样例 : "flag_test"

string

businessId
可选

样例 : "1299507310231776"

string

businessType
可选

样例 : "type_test"

string

elementIds
可选

样例 : [ "12321" ]

< object > array

integrateId
可选

样例 : "1299498154893536"

string

CategoryNode

名称 说明 类型

categoryId
可选

样例 : "c18f9549f53f44119c1444dd47ebf13d"

string

categoryName
可选

样例 : "categoryName"

string

elements
可选

样例 : [ "ElementNode" ]

< ElementNode > array

itemCount
可选

样例 : 0

integer (int32)

Changed«Attribute»

名称 说明 类型

_A
可选

样例 : Attribute

_B
可选

样例 : Attribute

Changed«Quantity»

名称 说明 类型

_A
可选

样例 : Quantity

_B
可选

样例 : Quantity

Coordinate

名称 说明 类型

x
可选

样例 : -4938.068482562385

number (double)

y
可选

样例 : -3201.59397858169

number (double)

z
可选

样例 : 0.0

number (double)

CustomizedTree

名称 说明 类型

item
可选

样例 : CustomizedTree

type
可选

样例 : "specialty"

enum (specialty, systemType, floor, category, family, familyType, building, unit)

DatabagInfo

名称 说明 类型

length
可选

样例 : 0

integer (int64)

DrawingSheet

名称 说明 类型

fileId
可选

样例 : 0

integer (int64)

portsAndViews
可选

样例 : [ "PortAndView" ]

< PortAndView > array

viewInfo
可选

样例 : View

ElementBusinessAssociation

名称 说明 类型

businessFlag
可选

样例 : "flag_test"

string

businessIds
可选

样例 : [ "1299507310231776" ]

< object > array

businessType
可选

样例 : "type_test"

string

elementId
可选

样例 : "12321"

string

integrateId
可选

样例 : "1299498154893536"

string

ElementIdWithBoundingBox

名称 说明 类型

boundingBox
可选

样例 : BoundingBox

elementId
可选

样例 : "313052"

string

ElementIdWithFileId

名称 说明 类型

elementId
可选

样例 : "313052"

string

fileId
可选

样例 : "cce34cec5412bfdb412b97d4fd0b30ec"

string

ElementIdWithName

名称 说明 类型

elementId
可选

样例 : "1873264"

string

name
可选

样例 : "name"

string

ElementNode

名称 说明 类型

diffType
可选

样例 : "string"

enum (new, delete, change)

followingElementId
可选

样例 : "8f33abe522674de78c3d338980589518"

string

followingFileId
可选

样例 : "5c02005992e74b7daaf053cc87d3a915"

string

name
可选

样例 : "name"

string

previousElementId
可选

样例 : "70389322f5c94450abbf48e49bef0edc"

string

previousFileId
可选

样例 : "e6f8b83c51b1480394b9d95291e8a409"

string

ElementPropertyFilterRequest

名称 说明 类型

elementIds
可选

样例 : [ "313154", "313047" ]

< string > array

filter
可选

样例 : [ { "group" : "default" }, { "group" : "shape" }, { "group" : "size", "keys" : [ "length", "width", "a" ] } ]

< GroupAndKeysPair > array

ElementQuantityChild

名称 说明 类型

elementId
可选

样例 : "1873264"

string

elementQuantities
可选

样例 : [ "ElementQuantityItem" ]

name
可选

样例 : "name"

string

ElementQuantityItem

名称 说明 类型

code
可选

样例 : "code"

string

quantity
可选

样例 : 0.0

number (float)

ElementQuantitySchemaItem

名称 说明 类型

code
可选

样例 : "code"

string

name
可选

样例 : "name"

string

ElementQuantityVO

名称 说明 类型

children
可选

样例 : [ "ElementQuantityChild" ]

elementId
可选

样例 : "1873264"

string

elementQuantities
可选

样例 : [ "ElementQuantityItem" ]

floor
可选

样例 : "floor"

string

floorId
可选

样例 : "29538e371cb74def81b4902228c6fc9d"

string

name
可选

样例 : "name"

string

ElementsTreeRequest

名称 说明 类型

elements
可选

样例 : [ "ElementIdWithFileId" ]

hierarchy
可选

样例 : [ "CustomizedTree" ]

< CustomizedTree > array

ElementsWithBoundingBox

名称 说明 类型

boundingBox
可选

样例 : BoundingBox

elements
可选

样例 : [ "ElementIdWithFileId" ]

FileIdHashWithElementIds

名称 说明 类型

elementIds
可选

样例 : [ "13200421233953227195", "4979270284117701525", "-8098347145579605232" ]

< object > array

fileIdHash
可选

样例 : "1365346274583424"

string

FileTreeRequestBody

名称 说明 类型

customizedNodeKeys
可选

样例 : { "string" : "string" }

< string, string > map

desiredHierarchy
可选

样例 : [ "category", "family" ]

< object > array

FileViews

名称 说明 类型

fileId
可选

样例 : 1280438635534016

integer (int64)

views
可选

样例 : [ "View" ]

< View > array

FileWithDrawingSheets

名称 说明 类型

drawingSheets
可选

样例 : [ "DrawingSheet" ]

< DrawingSheet > array

fileId
可选

样例 : "1477981195354592"

string

fileName
可选

样例 : "A2-1030.rvt"

string

Floor

名称 说明 类型

archElev
可选

样例 : 0.0

number (float)

areas
可选

样例 : [ "ObjectOnFloor" ]

< ObjectOnFloor > array

elevation
可选

样例 : 0.0

number (float)

height
可选

样例 : 4000.0

number (float)

id
可选

样例 : "311"

string

miniMap
可选

样例 : "787e5907b0ca5cb35f5d10ba091a085b/resource/model/maps/elevation 1.png"

string

name
可选

样例 : "elevation 1"

string

rooms
可选

样例 : [ "ObjectOnFloor" ]

< ObjectOnFloor > array

structElev
可选

样例 : 0.0

number (float)

GeneralResponse

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«Area»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : Area

message
可选

样例 : ""

string

GeneralResponse«BarQuantityVO»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : BarQuantityVO

message
可选

样例 : ""

string

GeneralResponse«DatabagInfo»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : DatabagInfo

message
可选

样例 : ""

string

GeneralResponse«ElementQuantityVO»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«ElementsWithBoundingBox»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«Area»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Area" ]

< Area > array

message
可选

样例 : ""

string

GeneralResponse«List«BusinessElementAssociation»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«DrawingSheet»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DrawingSheet" ]

< DrawingSheet > array

message
可选

样例 : ""

string

GeneralResponse«List«ElementBusinessAssociation»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«ElementIdWithBoundingBox»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ElementIdWithBoundingBox" ]

message
可选

样例 : ""

string

GeneralResponse«List«ElementIdWithName»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ElementIdWithName" ]

< ElementIdWithName > array

message
可选

样例 : ""

string

GeneralResponse«List«ElementQuantitySchemaItem»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ElementQuantitySchemaItem" ]

message
可选

样例 : ""

string

GeneralResponse«List«FileViews»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "FileViews" ]

< FileViews > array

message
可选

样例 : ""

string

GeneralResponse«List«FileWithDrawingSheets»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "FileWithDrawingSheets" ]

message
可选

样例 : ""

string

GeneralResponse«List«Floor»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Floor" ]

< Floor > array

message
可选

样例 : ""

string

GeneralResponse«List«IntegrateFile»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "IntegrateFile" ]

< IntegrateFile > array

message
可选

样例 : ""

string

GeneralResponse«List«LinkGraphNode»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "LinkGraphNode" ]

< LinkGraphNode > array

message
可选

样例 : ""

string

GeneralResponse«List«Link»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Link" ]

< Link > array

message
可选

样例 : ""

string

GeneralResponse«List«MaterialInfo»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "MaterialInfo" ]

< MaterialInfo > array

message
可选

样例 : ""

string

GeneralResponse«List«PropertyValuesResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "PropertyValuesResp" ]

< PropertyValuesResp > array

message
可选

样例 : ""

string

GeneralResponse«List«Property»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Property" ]

< Property > array

message
可选

样例 : ""

string

GeneralResponse«List«RfaFamilyType»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "RfaFamilyType" ]

< RfaFamilyType > array

message
可选

样例 : ""

string

GeneralResponse«List«RoomWithElementIdFileIds»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "RoomWithElementIdFileIds" ]

message
可选

样例 : ""

string

GeneralResponse«List«RoomWithElementIds»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "RoomWithElementIds" ]

< RoomWithElementIds > array

message
可选

样例 : ""

string

GeneralResponse«List«Room»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Room" ]

< Room > array

message
可选

样例 : ""

string

GeneralResponse«List«SearchAreaIdsResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SearchAreaIdsResp" ]

< SearchAreaIdsResp > array

message
可选

样例 : ""

string

GeneralResponse«List«SearchElementIdsResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SearchElementIdsResp" ]

message
可选

样例 : ""

string

GeneralResponse«List«SearchRoomIdsResp»»

名称 说明