应用访问凭证获取
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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
将字符串 appKey:appSecret 拼接后(中间用冒号连接),对其进行BASE64编码, 然后在编码后的字符串前添加字符串Basic和一个空格, 即:“Basic” + “ ” + Base64Encode(appKey + “:” + appSecret) |
string |
Query |
credential |
credential |
string |
获取模型的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) |
错误码
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) |
源文件相关
在注册成为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 |
指定外部文件url方式上传
PUT https://file.bimface.com/upload
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Query |
etag |
文件etag |
string |
Query |
name |
文件的全名,使用URL编码(UTF-8),最多256个字符 |
string |
Query |
sourceId |
调用方的文件源ID,不能重复 |
string |
Query |
url |
文件所在url |
string |
文件直传
BIMFACE使用了分布式对象存储来存储用户上传的模型/图纸文件。如使用普通的文件上传接口, 文件流会通过BIMFACE的服务器,再流向最终的分布式存储系统,整个上传过程会受BIMFACE服务器的带宽限制,上传速度非最优。 如使用文件直传接口,开发者应用在申请到一个Policy凭证后,可以直接上传文件跟BIMFACE后台的分布式存储系统, 这样上传速度和稳定性都会有提升,是我们推荐的上传方式。
另外,很多BIMFACE应用都有自己的Web前端页面,如果在前端JS代码里直接使用普通的文件上传接口会暴露Access token, 有安全性风险,这种情况我们也推荐使用文件直传接口。
获取文件直传的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
{
"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" : "ad682689119b4123b6dc9b53933432a3"
},
"message" : ""
}
断点续传
当文件比较大,或者所在网络网速较慢的情况下,单个文件上传的时间会比较长。如果中间有任何的网络错误, 本次上传就会被中断,那么文件就会需要重新上传,非常浪费时间。
为解决这个问题,BIMFACE提供了断点上传的接口,开发者可以利用这些接口对文件进行上传,即使上传过程种出现错误, 下一次也可以从上次错误的文件位置开始继续上传。
创建追加文件
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
{
"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}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Path |
appendFileId |
追加文件id |
integer (int64) |
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) |
|
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) |
|
Query |
scope |
scope |
string |
|
Query |
startTime |
起始日期,格式为 yyyy-MM-dd |
string |
|
Query |
status |
文件状态,uploading,success,failure |
string |
|
Query |
suffix |
文件后缀 |
string |
获取文件信息
GET https://file.bimface.com/metadata
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Query |
fileId |
文件ID |
integer (int64) |
源文件下载
文件转换
在代表模型的源文件上传到BIMFACE后,一般会进行三种API调用操作:
-
发起模型转换
-
查询转换状态
-
如转换成功,获取模型转换后的BIM数据
- 在模型成功进行转换后,模型内的BIM信息会在云端进行解析,抽取并结构化入库。这些信息包含:
-
-
构件属性信息
-
构件分类树
-
楼层
-
单体
-
专业
-
构件材质
-
模型链接
-
空间
-
房间
-
图纸
-
…
-
在确认模型转换成功后,为了开发者能方便的获取这些BIM信息并集成在自己的应用中,BIMFACE提供了一系列的数据接口,这些接口支持两种验权方式:
- Access token
-
代表自身应用的身份,使用应用的appkey, secret,通过调用/oauth2/token接口获取。
- View token
-
代表对单个模型的访问权限,使用access token,通过调用/view/token以及相关接口获得。
发起源文件/模型转换
发起转换
PUT https://api.bimface.com/translate
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会回调该地址 |
||
config |
Json Object |
N |
转换引擎自定义参数,config参数跟转换引擎相关,不同的转换引擎支持不同的config格式。例如转换时添加内置材质,则添加参数值{"texture":true},添加外部材质时参考“使用模型外置材质场景”请求报文 |
{"texture":true}等 |
回调(Callback)
待BIMFace转换完毕后,根据应用传入的回调地址,BIMFace会通知转换结果,转换可能成功、也可能失败。 |
获取转换状态
GET https://api.bimface.com/translate
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列表
GET https://api.bimface.com/data/v2/files/{fileId}/elementIds
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
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 |
获取构件材质列表
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
{
"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
{
"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
{
"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 |
获取模型链接信息
GET https://api.bimface.com/data/v2/files/{fileId}/links
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Path |
fileId |
代表该单模型的文件ID |
integer (int64) |
获取单个房间信息
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
{
"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 |
|
Path |
fileId |
fileId |
integer (int64) |
|
Query |
floorId |
floorId |
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"
}
}
获取单个面积分区信息
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
{
"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 |
|
Query |
v |
格式 |
string |
|
Body |
fileTreeRequest |
fileTreeRequest |
其他请求体示例和返回示例
请求2.0的默认分类树(floor, category, family, familyType)
返回体示例
{
"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)
请求体示例
{
"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
{
"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
{
"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机制通知调用方;另外,调用方也可以通过接口查询集成状态
HTTP请求示例
请求 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会回调该地址 |
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 | 说明 |
---|---|
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会通知结果。 |
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返回的签名一致,则证明该消息是安全可靠的。 |
查询集成状态
GET https://api.bimface.com/integrate
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" : ""
}
集成模型数据
获取指定构件的属性
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
{
"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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Path |
integrateId |
集成ID |
integer (int64) |
Body |
fileIdHashWithElementIdsList |
fileIdHashWithElementIdsList |
< FileIdHashWithElementIds > array |
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请求示例
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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Path |
integrateId |
集成ID |
integer (int64) |
Body |
fileIdHashWithElementIdsList |
fileIdHashWithElementIdsList |
< FileIdHashWithElementIds > array |
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
{
"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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
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
{
"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 |
|
Body |
requestBody |
指定排序,显示的构件列表等可选项 |
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)
返回体示例:
{
"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)
返回体示例
{
"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
返回体示例
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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请求示例
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 |
模型对比
模型对比可以对两个文件/模型进行差异性分析,确定两个文件/模型之间构件的几何和属性差异,包括增加的构件、删除的构件和修改的构件。 模型对应可以用于进行文件/模型的版本对比。
- 几何对比
-
几何数据的对比的粒度为构件级,即只要构件的某一部分几何数据或材质发生改变,就认为整个构件发生变化。
- 属性对比
-
属性对比的粒度为构件的属性级,即对两个文件中的相同ID的构件挨个属性值进行对比。
不同版本的模型文件上传并转换成功后,即可发起模型对比。由于对比不能立即完成,BIMFace支持在模型对比完成以后,通过Callback机制通知应用;另外,应用也可以通过接口查询对比状态。 |
发起模型对比
POST https://api.bimface.com/v2/compare
HTTP请求示例
请求 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会回调该地址 |
返回体参数说明
字段 | 类型 | 描述 | 示例 |
---|---|---|---|
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 |
回调(Callback)
待BIMFace对比完毕后,根据应用传入的回调地址,BIMFace会通知对比结果,对比可能成功、也可能失败。 |
Url参数
字段 | 类型 | 描述 |
---|---|---|
compareId |
Number |
模型对比ID |
status |
String |
模型对比状态 |
reason |
String |
若对比失败,则返回失败原因 |
thumbnail |
String |
模型对比模型的缩略图,多个缩略图用``,''分隔(如果有缩略图的话) |
nonce |
String |
回调随机数 |
signature |
String |
签名 |
signature(签名):为了确保回调消息是由BIMFace发出的,应用在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:fileId:status:nonce''),如果应用计算的签名与BIMFace返回的签名一致,则证明该消息是安全可靠的。 |
获取模型对比状态
GET https://api.bimface.com/v2/compare
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" : ""
}
删除模型对比
DELETE https://api.bimface.com/v2/compare
获取模型构件对比差异
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
{
"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[] |
修改属性列表 |
… |
获取模型对比构件分类树
GET https://api.bimface.com/data/v2/comparisons/{comparisonId}/tree
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Path |
comparisonId |
对比ID |
integer (int64) |
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
{
"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
查询指定模型构件属性的所有可能值
GET https://api.bimface.com/data/v2/query/propertyValues
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Header |
Authorization |
authorization header |
string |
|
Query |
properties |
需要查询的属性列表 |
< string > array(multi) |
|
Query |
targetIds |
目标ID |
< string > array(multi) |
|
Query |
targetType |
目标类型 |
string |
|
查询符合条件的面积分区ID列表
GET https://api.bimface.com/data/v2/query/areaIds
构件空间关系计算
在进行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。
参数 roomToleranceXY 说明
默认值:ORDINARY
STRICT:element的XY平面四个顶点都在room的boundary里面
ORDINARY:element的XY平面四个顶点和一个中心点共五个点,有三个包含在room的boundary里面
LENIENT:element的XY平面四个顶点和一个中心点共五个点,有一个包含在room的boundary里面
如下图:黑色多边形表示room的boundary,红色矩形表示element的BoundingBox在XY平面的投影,蓝色点表示红色矩形的中心点,每张图下面注明了哪些参数认定此情况room包含了element。
获取楼层对应房间列表
GET https://api.bimface.com/data/v2/files/{fileId}/rooms
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
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) |
|
Query |
roomToleranceZ |
Z方向的误差容许程度 |
enum (STRICT, ORDINARY, LENIENT) |
|
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
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
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) |
|
Query |
roomToleranceZ |
Z方向的误差容许程度 |
enum (STRICT, ORDINARY, LENIENT) |
|
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) |
获取缩略图链接
GET https://api.bimface.com/data/v2/databag/thumbnail
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Query |
fileId |
文件ID |
integer (int64) |
Query |
size |
缩略图大小 |
integer (int32) |
获取dwg模型zip包下载地址
GET https://api.bimface.com/data/databag/dwg
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Query |
fileId |
文件ID |
integer (int64) |
获取数据包内PDF文件链接
GET https://api.bimface.com/data/v2/databag/pdf
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Query |
dwgFileId |
DWG文件ID |
integer (int64) |
获取指定布局的预览图片链接
GET https://api.bimface.com/data/v2/databag/previewImage
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Query |
dwgFileId |
DWG文件ID |
integer (int64) |
Query |
layoutName |
layout名字 |
string |
离线数据包相关
由于用户所在环境以及应用开发自身的需求,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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Path |
fileId |
通过文件ID创建离线数据包 |
integer (int64) |
Query |
callback |
回调url |
string |
Body |
request |
DatabagDerivativeRequest请求体 |
HTTP请求示例
HTTP响应示例
返回体参数说明
字段 | 类型 | 描述 | 示例 |
---|---|---|---|
fileId |
Long |
文件转换Id |
8167234891 |
databagVersion |
String |
离线包版本 |
2.0 |
status |
String |
离线包状态 |
processing(生成中)、success(生成成功)、failed(生成失败) |
reason |
String |
若生成失败,返回失败原因 |
… |
createTime |
String |
离线包生成时间 |
2016-08-08 12:36:47 |
错误码
code | 说明 |
---|---|
system.error |
BIMFACE系统异常 |
authentication.failed |
API访问合法性校验失败 |
file.not.found |
文件不存在 |
file.not.translated |
文件没有发起转换,不能生成离线包 |
file.translating |
文件正在转换中,不能生成离线包 |
file.translate.failure |
文件转换失败,不能生成离线包 |
回调(Callback)
待离线包生成后,根据调用方传入的回调地址,BIMFACE会通知结果。 |
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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Path |
integrateId |
通过集成模型ID创建离线数据包 |
integer (int64) |
Query |
callback |
回调url |
string |
Body |
request |
DatabagDerivativeRequest请求体 |
HTTP请求示例
HTTP响应示例
返回体参数说明
字段 | 类型 | 描述 | 示例 |
---|---|---|---|
integrateId |
Long |
集成模型ID |
8167234891 |
databagVersion |
String |
离线包版本 |
2.0 |
status |
String |
离线包状态 |
processing(生成中)、success(生成成功)、failed(生成失败) |
reason |
String |
若生成失败,返回失败原因 |
… |
createTime |
String |
离线包生成时间 |
2016-08-08 12:36:47 |
错误码
code | 说明 |
---|---|
system.error |
BIMFACE系统异常 |
authentication.failed |
API访问合法性校验失败 |
integration.not.found |
集成模型未找到 |
integration.not.translated |
模型未集成,不能生成离线包 |
integration.translating |
模型正在集成中,不能生成离线包 |
integration.translate.failure |
模型集成失败,不能生成离线包 |
回调(Callback)
待离线包生成后,根据调用方传入的回调地址,BIMFACE会通知结果。 |
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
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Path |
compareId |
通过模型对比ID创建离线数据包 |
integer (int64) |
Query |
callback |
回调url |
string |
Body |
request |
DatabagDerivativeRequest请求体 |
HTTP请求示例
HTTP响应示例
返回体参数说明
字段 | 类型 | 描述 | 示例 |
---|---|---|---|
compareId |
Long |
对比模型ID |
8167234891 |
databagVersion |
String |
离线包版本 |
2.0 |
status |
String |
离线包状态 |
processing(生成中)、success(生成成功)、failed(生成失败) |
reason |
String |
若生成失败,返回失败原因 |
… |
createTime |
String |
离线包生成时间 |
2016-08-08 12:36:47 |
错误码
code | 说明 |
---|---|
system.error |
BIMFACE系统异常 |
authentication.failed |
API访问合法性校验失败 |
compare.not.found |
对比文件未找到 |
compare.not.translated |
对比文件没有转换,不能生成离线包 |
compare.translating |
对比文件转换中,不能生成离线包 |
compare.translate.failure |
对比文件转换失败,不能生成离线包 |
回调(Callback)
待离线包生成后,根据调用方传入的回调地址,BIMFACE会通知结果。 |
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
查询模型对比离线数据包
GET https://api.bimface.com/comparisions/{compareId}/offlineDatabag
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Path |
compareId |
通过模型对比ID查询离线数据包 |
integer (int64) |
查询集成模型离线数据包
GET https://api.bimface.com/integrations/{integrateId}/offlineDatabag
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Path |
integrateId |
通过集成模型ID查询离线数据包 |
integer (int64) |
获取数据包下载地址
GET https://api.bimface.com/data/databag/downloadUrl
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
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 |
双向业务挂接
第三方应用在与BIMFACE数据进行集成的时候,一个通用的需求,就是要把一些应用中的业务实体对象(如任务, 质量安全检查点, 问题隐患等等)与模型中的构件进行双向挂接,“双向”指的是在单模型或集成模型中,可以:
-
从构件Id查询与之关联的所有业务实体Id(待补充)。
-
从业务实体对象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 |
新增双向业务挂接项 |
根据业务实体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 |
根据构件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 |
删除业务挂接
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 |
删除业务实体关联的业务挂接
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) |
删除构件关联的业务挂接
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 |
删除业务挂接
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) |
rfa构件数据
rfa文件族类型属性key列表
GET https://api.bimface.com/data/v2/rfaFiles/{rfaFileId}/propertyNames
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
authorization header |
string |
Path |
rfaFileId |
文件ID |
integer (int64) |
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请求示例
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" : ""
}
分享链接相关
生成分享链接
POST https://api.bimface.com/share
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
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 |
显示分享列表
GET https://api.bimface.com/shares
取消分享链接
DELETE https://api.bimface.com/share
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Query |
fileId |
文件ID(集成ID二选一) |
integer (int64) |
Query |
integrateId |
集成ID(文件ID二选一) |
integer (int64) |
批量取消分享链接
DELETE https://api.bimface.com/shares
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Header |
Authorization |
认证信息头 |
string |
Query |
sourceIds |
sourceIds |
< integer (int64) > array(multi) |
数据实体类
AccessTokenBean
名称 | 说明 | 类型 |
---|---|---|
expireTime |
样例 : |
string |
token |
样例 : |
string |
BusinessAssociationBean
名称 | 说明 | 类型 |
---|---|---|
associationId |
样例 : |
integer (int64) |
config |
样例 : |
object |
createTime |
样例 : |
string |
integrateId |
样例 : |
integer (int64) |
name |
样例 : |
string |
priority |
最小值 : |
integer (int32) |
reason |
样例 : |
string |
ruleFileIds |
样例 : |
< integer (int64) > array |
sourceId |
样例 : |
string |
status |
样例 : |
string |
BusinessAssociationRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
config |
样例 : |
object |
integrateId |
样例 : |
integer (int64) |
name |
样例 : |
string |
priority |
最小值 : |
integer (int32) |
ruleFileIds |
样例 : |
< object > array |
sourceId |
样例 : |
string |
CompareRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
comparedEntityType |
样例 : |
string |
config |
样例 : |
object |
followingId |
样例 : |
integer (int64) |
name |
样例 : |
string |
previousId |
样例 : |
integer (int64) |
priority |
样例 : |
integer (int32) |
sourceId |
样例 : |
string |
DatabagDerivativeBean
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
string |
databagVersion |
样例 : |
string |
length |
样例 : |
integer (int64) |
reason |
样例 : |
string |
status |
样例 : |
string |
ElementPropertyOverride
名称 | 说明 | 类型 |
---|---|---|
keyToMatch |
样例 : |
string |
keyToOverride |
样例 : |
string |
targetFileIds |
样例 : |
< object > array |
valueOverrides |
样例 : |
< ElementPropertyValueOverride > array |
ElementPropertyValueOverride
名称 | 说明 | 类型 |
---|---|---|
valueToMatch |
样例 : |
string |
valueToOverride |
样例 : |
string |
FileIntegrateBean
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
string |
integrateId |
样例 : |
integer (int64) |
name |
样例 : |
string |
priority |
样例 : |
integer (int32) |
reason |
样例 : |
string |
sourceId |
样例 : |
string |
status |
样例 : |
string |
thumbnail |
样例 : |
< object > array |
FileIntegrateRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
config |
样例 : |
string |
floorMapping |
样例 : |
< FloorMappingItem > array |
floorSort |
样例 : |
< string > array |
internalConfigMap |
样例 : |
< string, string > map |
name |
样例 : |
string |
parentIntegrateId |
样例 : |
integer (int64) |
priority |
样例 : |
integer (int32) |
propertyOverrides |
样例 : |
< ElementPropertyOverride > array |
ruleFileIds |
样例 : |
< object > array |
sourceId |
样例 : |
string |
sources |
样例 : |
< IntegrateSource > array |
specialtySort |
样例 : |
< string > array |
FileTranslateBean
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
string |
databagId |
样例 : |
string |
fileId |
样例 : |
integer (int64) |
name |
样例 : |
string |
priority |
样例 : |
integer (int32) |
reason |
样例 : |
string |
status |
样例 : |
string |
thumbnail |
样例 : |
< object > array |
FileTranslateRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
config |
样例 : |
< string, string > map |
priority |
样例 : |
integer (int32) |
source |
样例 : TranslateSource |
FloorMappingItem
名称 | 说明 | 类型 |
---|---|---|
fileFloorId |
样例 : |
string |
projectFloorId |
样例 : |
string |
projectFloorName |
样例 : |
string |
GeneralResponse
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
object |
message |
样例 : |
string |
GeneralResponse«AccessTokenBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : AccessTokenBean |
|
message |
样例 : |
string |
GeneralResponse«BusinessAssociationBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«DatabagDerivativeBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«FileIntegrateBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : FileIntegrateBean |
|
message |
样例 : |
string |
GeneralResponse«FileTranslateBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : FileTranslateBean |
|
message |
样例 : |
string |
GeneralResponse«InsecureShareLinkBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«List«DatabagDerivativeBean»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< DatabagDerivativeBean > array |
message |
样例 : |
string |
GeneralResponse«List«ProjectIntegrateBean»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ProjectIntegrateBean > array |
message |
样例 : |
string |
GeneralResponse«List«ProjectOperationBean»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ProjectOperationBean > array |
message |
样例 : |
string |
GeneralResponse«List«ShareLinkBean»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ShareLinkBean > array |
message |
样例 : |
string |
GeneralResponse«ModelCompareBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : ModelCompareBean |
|
message |
样例 : |
string |
GeneralResponse«ModelVersionInfo»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : ModelVersionInfo |
|
message |
样例 : |
string |
GeneralResponse«ProjectBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : ProjectBean |
|
message |
样例 : |
string |
GeneralResponse«ShareLinkBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : ShareLinkBean |
|
message |
样例 : |
string |
GeneralResponse«boolean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
boolean |
message |
样例 : |
string |
GeneralResponse«string»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
string |
message |
样例 : |
string |
InsecureShareLinkBean
名称 | 说明 | 类型 |
---|---|---|
appKey |
样例 : |
string |
expireTime |
样例 : |
string |
passwordProtect |
样例 : |
boolean |
sourceId |
样例 : |
integer (int64) |
sourceType |
样例 : |
string |
url |
样例 : |
string |
IntegrateSource
名称 | 说明 | 类型 |
---|---|---|
building |
样例 : |
string |
databagId |
样例 : |
string |
fileId |
样例 : |
integer (int64) |
fileName |
样例 : |
string |
floor |
样例 : |
string |
floorSort |
样例 : |
number (float) |
specialty |
样例 : |
string |
specialtySort |
样例 : |
number (float) |
transform |
样例 : |
< number (double) > array |
ModelAndView
名称 | 说明 | 类型 |
---|---|---|
empty |
样例 : |
boolean |
model |
样例 : |
object |
modelMap |
样例 : |
< string, object > map |
reference |
样例 : |
boolean |
status |
样例 : |
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 |
ModelCompareBean
名称 | 说明 | 类型 |
---|---|---|
compareId |
样例 : |
integer (int64) |
createTime |
样例 : |
string |
name |
样例 : |
string |
priority |
最小值 : |
integer (int32) |
reason |
样例 : |
string |
sourceId |
样例 : |
string |
status |
样例 : |
string |
thumbnail |
样例 : |
< object > array |
ModelCompareItem
名称 | 说明 | 类型 |
---|---|---|
followingDatabagId |
样例 : |
string |
followingFileId |
样例 : |
integer (int64) |
followingFileName |
样例 : |
string |
previousDatabagId |
样例 : |
string |
previousFileId |
样例 : |
integer (int64) |
previousFileName |
样例 : |
string |
ModelCompareRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
name |
样例 : |
string |
priority |
样例 : |
integer (int32) |
sourceId |
样例 : |
string |
sources |
样例 : |
< ModelCompareItem > array |
ModelVersionInfo
名称 | 说明 | 类型 |
---|---|---|
config |
样例 : |
< string, string > map |
databagId |
样例 : |
string |
isSupportComponentProperty |
样例 : |
boolean |
isSupportDrawing |
样例 : |
boolean |
isSupportFamilyTypeList |
样例 : |
boolean |
isSupportMaterialProperty |
样例 : |
boolean |
isSupportMiniMap |
样例 : |
boolean |
isSupportModelTree |
样例 : |
boolean |
isSupportRoomArea |
样例 : |
boolean |
isSupportWalk |
样例 : |
boolean |
jsSDKVersion |
样例 : |
string |
modelId |
样例 : |
integer (int64) |
modelType |
样例 : |
string |
name |
样例 : |
string |
renderType |
样例 : |
string |
renderVersion |
样例 : |
string |
subRenders |
样例 : |
< RenderInfo > array |
type |
最小值 : |
integer (int32) |
workerType |
样例 : |
string |
ProjectBean
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
string |
id |
样例 : |
integer (int64) |
integrateId |
样例 : |
integer (int64) |
integrateStatus |
样例 : |
string |
name |
样例 : |
string |
ProjectCreateRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
integrate |
样例 : FileIntegrateRequest |
|
materialOverrideSetFileId |
样例 : |
integer (int64) |
metaFileId |
样例 : |
integer (int64) |
name |
样例 : |
string |
segmentFileId |
样例 : |
integer (int64) |
ProjectIntegrateBean
名称 | 说明 | 类型 |
---|---|---|
active |
样例 : |
boolean |
createTime |
样例 : |
string |
integrateId |
样例 : |
integer (int64) |
parentIntegrateId |
样例 : |
integer (int64) |
status |
样例 : |
string |
ProjectModifyRequest
名称 | 说明 | 类型 |
---|---|---|
addedFileIds |
样例 : |
< object > array |
callback |
样例 : |
string |
changedFileIds |
样例 : |
< Diff > array |
deletedFileIds |
样例 : |
< object > array |
materialOverrideSetFileId |
样例 : |
integer (int64) |
metaFileId |
样例 : |
integer (int64) |
segmentFileId |
样例 : |
integer (int64) |
transformMap |
样例 : |
< string, < number (double) > array > map |
ProjectOperationBean
名称 | 说明 | 类型 |
---|---|---|
addedFiles |
样例 : |
string |
callbackStatus |
样例 : |
integer (int32) |
callbackTimes |
最小值 : |
integer (int32) |
callbackUrl |
样例 : |
string |
changedFiles |
样例 : |
string |
createTime |
样例 : |
integer (int64) |
deletedFiles |
样例 : |
string |
id |
样例 : |
integer (int64) |
integrate |
样例 : |
boolean |
jobId |
样例 : |
integer (int64) |
jobSourceId |
样例 : |
integer (int64) |
metaFileId |
样例 : |
integer (int64) |
mosFileId |
样例 : |
integer (int64) |
projectId |
样例 : |
integer (int64) |
segmentFileId |
样例 : |
integer (int64) |
status |
最小值 : |
integer (int32) |
transform |
样例 : |
string |
workerCode |
样例 : |
string |
workerMessage |
样例 : |
string |
ProjectOperationFixRequest
名称 | 说明 | 类型 |
---|---|---|
callback |
样例 : |
string |
replaceFileMap |
样例 : |
< string, integer (int64) > map |
transformMap |
样例 : |
< string, < number (double) > array > map |
RenderInfo
名称 | 说明 | 类型 |
---|---|---|
isSupportComponentProperty |
样例 : |
boolean |
isSupportFamilyTypeList |
样例 : |
boolean |
isSupportMiniMap |
样例 : |
boolean |
isSupportModelTree |
样例 : |
boolean |
jsSDKVersion |
样例 : |
string |
renderType |
样例 : |
string |
renderVersion |
样例 : |
string |
ShareLinkBean
名称 | 说明 | 类型 |
---|---|---|
appKey |
样例 : |
string |
expireTime |
样例 : |
string |
password |
样例 : |
string |
sourceId |
样例 : |
integer (int64) |
sourceName |
样例 : |
string |
sourceType |
样例 : |
string |
url |
样例 : |
string |
TranslateSource
名称 | 说明 | 类型 |
---|---|---|
compressed |
样例 : |
boolean |
fileId |
样例 : |
integer (int64) |
rootName |
样例 : |
string |
AppendFileBean
名称 | 说明 | 类型 |
---|---|---|
appendFileId |
样例 : |
integer (int64) |
createTime |
样例 : |
string |
file |
样例 : FileBean |
|
length |
样例 : |
integer (int64) |
name |
样例 : |
string |
position |
样例 : |
integer (int64) |
status |
样例 : |
string |
FileBean
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
string |
etag |
样例 : |
string |
fileId |
样例 : |
integer (int64) |
length |
样例 : |
integer (int64) |
name |
样例 : |
string |
status |
样例 : |
string |
suffix |
样例 : |
string |
GeneralResponse
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
object |
message |
样例 : |
string |
GeneralResponse«AppendFileBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : AppendFileBean |
|
message |
样例 : |
string |
GeneralResponse«FileBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : FileBean |
|
message |
样例 : |
string |
GeneralResponse«List«FileBean»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< FileBean > array |
message |
样例 : |
string |
GeneralResponse«SupportFileBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : SupportFileBean |
|
message |
样例 : |
string |
GeneralResponse«UploadPolicyBean»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : UploadPolicyBean |
|
message |
样例 : |
string |
GeneralResponse«string»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
string |
message |
样例 : |
string |
SupportFileBean
名称 | 说明 | 类型 |
---|---|---|
length |
样例 : |
integer (int64) |
types |
样例 : |
< object > array |
UploadPolicyBean
名称 | 说明 | 类型 |
---|---|---|
accessId |
样例 : |
string |
callbackBody |
样例 : |
string |
expire |
样例 : |
integer (int64) |
host |
样例 : |
string |
objectKey |
样例 : |
string |
policy |
样例 : |
string |
signature |
样例 : |
string |
sourceId |
样例 : |
string |
Area
名称 | 说明 | 类型 |
---|---|---|
area |
样例 : |
number (double) |
boundary |
样例 : |
string |
id |
样例 : |
string |
levelId |
样例 : |
string |
maxPt |
样例 : Coordinate |
|
minPt |
样例 : Coordinate |
|
name |
样例 : |
string |
perimeter |
样例 : |
number (double) |
properties |
样例 : |
< PropertyGroup > array |
viewName |
样例 : |
string |
BarQuantityItem
名称 | 说明 | 类型 |
---|---|---|
desc |
样例 : |
string |
name |
样例 : |
string |
quantity |
样例 : |
number (float) |
BarQuantityVO
名称 | 说明 | 类型 |
---|---|---|
barQuantities |
样例 : |
< BarQuantityItem > array |
elementId |
样例 : |
string |
floor |
样例 : |
string |
floorId |
样例 : |
string |
name |
样例 : |
string |
BoundingBox
名称 | 说明 | 类型 |
---|---|---|
max |
样例 : Coordinate |
|
min |
样例 : Coordinate |
BusinessAssociation
名称 | 说明 | 类型 |
---|---|---|
businessFlag |
样例 : |
string |
businessId |
样例 : |
string |
businessType |
样例 : |
string |
elementId |
样例 : |
string |
BusinessAssociationRequest
名称 | 说明 | 类型 |
---|---|---|
associations |
样例 : |
< BusinessAssociation > array |
businessFlag |
样例 : |
string |
businessType |
样例 : |
string |
BusinessElementAssociation
名称 | 说明 | 类型 |
---|---|---|
businessFlag |
样例 : |
string |
businessId |
样例 : |
string |
businessType |
样例 : |
string |
elementIds |
样例 : |
< object > array |
integrateId |
样例 : |
string |
CategoryNode
名称 | 说明 | 类型 |
---|---|---|
categoryId |
样例 : |
string |
categoryName |
样例 : |
string |
elements |
样例 : |
< ElementNode > array |
itemCount |
样例 : |
integer (int32) |
Coordinate
名称 | 说明 | 类型 |
---|---|---|
x |
样例 : |
number (double) |
y |
样例 : |
number (double) |
z |
样例 : |
number (double) |
CustomizedTree
名称 | 说明 | 类型 |
---|---|---|
item |
样例 : CustomizedTree |
|
type |
样例 : |
enum (specialty, systemType, floor, category, family, familyType, building, unit) |
DrawingSheet
名称 | 说明 | 类型 |
---|---|---|
fileId |
样例 : |
integer (int64) |
portsAndViews |
样例 : |
< PortAndView > array |
viewInfo |
样例 : View |
ElementBusinessAssociation
名称 | 说明 | 类型 |
---|---|---|
businessFlag |
样例 : |
string |
businessIds |
样例 : |
< object > array |
businessType |
样例 : |
string |
elementId |
样例 : |
string |
integrateId |
样例 : |
string |
ElementIdWithBoundingBox
名称 | 说明 | 类型 |
---|---|---|
boundingBox |
样例 : BoundingBox |
|
elementId |
样例 : |
string |
ElementIdWithFileId
名称 | 说明 | 类型 |
---|---|---|
elementId |
样例 : |
string |
fileId |
样例 : |
string |
ElementNode
名称 | 说明 | 类型 |
---|---|---|
diffType |
样例 : |
enum (new, delete, change) |
followingElementId |
样例 : |
string |
followingFileId |
样例 : |
string |
name |
样例 : |
string |
previousElementId |
样例 : |
string |
previousFileId |
样例 : |
string |
ElementPropertyFilterRequest
名称 | 说明 | 类型 |
---|---|---|
elementIds |
样例 : |
< string > array |
filter |
样例 : |
< GroupAndKeysPair > array |
ElementQuantityChild
名称 | 说明 | 类型 |
---|---|---|
elementId |
样例 : |
string |
elementQuantities |
样例 : |
< ElementQuantityItem > array |
name |
样例 : |
string |
ElementQuantityVO
名称 | 说明 | 类型 |
---|---|---|
children |
样例 : |
< ElementQuantityChild > array |
elementId |
样例 : |
string |
elementQuantities |
样例 : |
< ElementQuantityItem > array |
floor |
样例 : |
string |
floorId |
样例 : |
string |
name |
样例 : |
string |
ElementsTreeRequest
名称 | 说明 | 类型 |
---|---|---|
elements |
样例 : |
< ElementIdWithFileId > array |
hierarchy |
样例 : |
< CustomizedTree > array |
ElementsWithBoundingBox
名称 | 说明 | 类型 |
---|---|---|
boundingBox |
样例 : BoundingBox |
|
elements |
样例 : |
< ElementIdWithFileId > array |
FileIdHashWithElementIds
名称 | 说明 | 类型 |
---|---|---|
elementIds |
样例 : |
< object > array |
fileIdHash |
样例 : |
string |
FileTreeRequestBody
名称 | 说明 | 类型 |
---|---|---|
customizedNodeKeys |
样例 : |
< string, string > map |
desiredHierarchy |
样例 : |
< object > array |
FileViews
名称 | 说明 | 类型 |
---|---|---|
fileId |
样例 : |
integer (int64) |
views |
样例 : |
< View > array |
FileWithDrawingSheets
名称 | 说明 | 类型 |
---|---|---|
drawingSheets |
样例 : |
< DrawingSheet > array |
fileId |
样例 : |
string |
fileName |
样例 : |
string |
Floor
名称 | 说明 | 类型 |
---|---|---|
archElev |
样例 : |
number (float) |
areas |
样例 : |
< ObjectOnFloor > array |
elevation |
样例 : |
number (float) |
height |
样例 : |
number (float) |
id |
样例 : |
string |
miniMap |
样例 : |
string |
name |
样例 : |
string |
rooms |
样例 : |
< ObjectOnFloor > array |
structElev |
样例 : |
number (float) |
GeneralResponse
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
object |
message |
样例 : |
string |
GeneralResponse«Area»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : Area |
|
message |
样例 : |
string |
GeneralResponse«BarQuantityVO»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : BarQuantityVO |
|
message |
样例 : |
string |
GeneralResponse«DatabagInfo»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : DatabagInfo |
|
message |
样例 : |
string |
GeneralResponse«ElementQuantityVO»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : ElementQuantityVO |
|
message |
样例 : |
string |
GeneralResponse«ElementsWithBoundingBox»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«List«Area»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< Area > array |
message |
样例 : |
string |
GeneralResponse«List«BusinessElementAssociation»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< BusinessElementAssociation > array |
message |
样例 : |
string |
GeneralResponse«List«DrawingSheet»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< DrawingSheet > array |
message |
样例 : |
string |
GeneralResponse«List«ElementBusinessAssociation»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ElementBusinessAssociation > array |
message |
样例 : |
string |
GeneralResponse«List«ElementIdWithBoundingBox»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ElementIdWithBoundingBox > array |
message |
样例 : |
string |
GeneralResponse«List«ElementIdWithName»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ElementIdWithName > array |
message |
样例 : |
string |
GeneralResponse«List«ElementQuantitySchemaItem»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< ElementQuantitySchemaItem > array |
message |
样例 : |
string |
GeneralResponse«List«FileViews»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< FileViews > array |
message |
样例 : |
string |
GeneralResponse«List«FileWithDrawingSheets»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< FileWithDrawingSheets > array |
message |
样例 : |
string |
GeneralResponse«List«Floor»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< Floor > array |
message |
样例 : |
string |
GeneralResponse«List«IntegrateFile»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< IntegrateFile > array |
message |
样例 : |
string |
GeneralResponse«List«LinkGraphNode»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< LinkGraphNode > array |
message |
样例 : |
string |
GeneralResponse«List«Link»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< Link > array |
message |
样例 : |
string |
GeneralResponse«List«MaterialInfo»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< MaterialInfo > array |
message |
样例 : |
string |
GeneralResponse«List«PropertyValuesResp»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< PropertyValuesResp > array |
message |
样例 : |
string |
GeneralResponse«List«Property»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< Property > array |
message |
样例 : |
string |
GeneralResponse«List«RfaFamilyType»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< RfaFamilyType > array |
message |
样例 : |
string |
GeneralResponse«List«RoomWithElementIdFileIds»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< RoomWithElementIdFileIds > array |
message |
样例 : |
string |
GeneralResponse«List«RoomWithElementIds»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< RoomWithElementIds > array |
message |
样例 : |
string |
GeneralResponse«List«Room»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< Room > array |
message |
样例 : |
string |
GeneralResponse«List«SearchAreaIdsResp»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< SearchAreaIdsResp > array |
message |
样例 : |
string |
GeneralResponse«List«SearchElementIdsResp»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< SearchElementIdsResp > array |
message |
样例 : |
string |
GeneralResponse«List«SearchRoomIdsResp»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< SearchRoomIdsResp > array |
message |
样例 : |
string |
GeneralResponse«List«SegmentDto»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< SegmentDto > array |
message |
样例 : |
string |
GeneralResponse«List«SegmentGroupDto»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< SegmentGroupDto > array |
message |
样例 : |
string |
GeneralResponse«List«SpecialtyNode»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< SpecialtyNode > array |
message |
样例 : |
string |
GeneralResponse«List«Tree»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< Tree > array |
message |
样例 : |
string |
GeneralResponse«List«View»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< View > array |
message |
样例 : |
string |
GeneralResponse«List«string»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
< string > array |
message |
样例 : |
string |
GeneralResponse«MaterialOverrideSetVO»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«ModelCompareChange»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : ModelCompareChange |
|
message |
样例 : |
string |
GeneralResponse«Pagination«ModelCompareDiff»»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«Property»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : Property |
|
message |
样例 : |
string |
GeneralResponse«RfaFamilyTypeProperty»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
||
message |
样例 : |
string |
GeneralResponse«Room»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : Room |
|
message |
样例 : |
string |
GeneralResponse«Tree»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : Tree |
|
message |
样例 : |
string |
GeneralResponse«object»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
object |
message |
样例 : |
string |
GeneralResponse«string»
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
string |
message |
样例 : |
string |
GetUrlSwaggerDisplay
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
string |
message |
样例 : |
string |
IntegrateFile
名称 | 说明 | 类型 |
---|---|---|
databagId |
样例 : |
string |
drawingSheetCount |
样例 : |
integer (int32) |
fileId |
样例 : |
integer (int64) |
fileName |
样例 : |
string |
floor |
样例 : |
string |
floorSort |
样例 : |
number (float) |
integrateId |
样例 : |
integer (int64) |
linkedBy |
样例 : |
< object > array |
specialty |
样例 : |
string |
specialtySort |
样例 : |
number (float) |
IntegrationTreeOptionalRequestBody
名称 | 说明 | 类型 |
---|---|---|
customizedNodeKeys |
样例 : |
< string, string > map |
fileIdElementIds |
样例 : |
< ElementIdWithFileId > array |
sortedNamesHierarchy |
样例 : |
< < string > array > array |
sorts |
样例 : |
< TreeNodeSort > array |
Link
名称 | 说明 | 类型 |
---|---|---|
guid |
样例 : |
string |
id |
样例 : |
integer (int64) |
name |
样例 : |
string |
transform |
样例 : |
string |
LinkGraphNode
名称 | 说明 | 类型 |
---|---|---|
databagId |
样例 : |
string |
fileId |
样例 : |
string |
linkName |
样例 : |
string |
linkPathHash |
样例 : |
string |
linkTransform |
样例 : |
string |
links |
样例 : |
< LinkGraphNode > array |
name |
样例 : |
string |
params |
样例 : |
< object > array |
MaterialInfo
名称 | 说明 | 类型 |
---|---|---|
id |
样例 : |
string |
name |
样例 : |
string |
parameters |
样例 : |
< PropertyGroup > array |
MaterialOverrideItemVO
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
integer (int64) |
id |
样例 : |
string |
material |
样例 : |
string |
overrideSequence |
样例 : |
integer (int32) |
target |
样例 : |
string |
targetType |
样例 : |
string |
updateTime |
样例 : |
integer (int64) |
MaterialOverrideSetVO
名称 | 说明 | 类型 |
---|---|---|
createTime |
样例 : |
integer (int64) |
id |
样例 : |
integer (int64) |
name |
样例 : |
string |
overrides |
样例 : |
< MaterialOverrideItemVO > array |
updateTime |
样例 : |
integer (int64) |
ModelCompareChange
名称 | 说明 | 类型 |
---|---|---|
_A |
样例 : |
string |
_B |
样例 : |
string |
changeAttributes |
样例 : |
< Changed«Attribute» > array |
changeQuantities |
样例 : |
< Changed«Quantity» > array |
deleteAttributes |
样例 : |
< Attribute > array |
deleteQuantities |
样例 : |
< Quantity > array |
newAttributes |
样例 : |
< Attribute > array |
newQuantities |
样例 : |
< Quantity > array |
ModelCompareDiff
名称 | 说明 | 类型 |
---|---|---|
categoryId |
样例 : |
string |
categoryName |
样例 : |
string |
diffType |
样例 : |
string |
elementId |
样例 : |
string |
elementName |
样例 : |
string |
family |
样例 : |
string |
followingFileId |
样例 : |
string |
id |
样例 : |
string |
previousFileId |
样例 : |
string |
specialty |
样例 : |
string |
ObjectOnFloor
名称 | 说明 | 类型 |
---|---|---|
boundary |
样例 : |
string |
id |
样例 : |
string |
levelId |
样例 : |
string |
maxPt |
样例 : Coordinate |
|
minPt |
样例 : Coordinate |
|
name |
样例 : |
string |
Pagination«ModelCompareDiff»
名称 | 说明 | 类型 |
---|---|---|
data |
样例 : |
< ModelCompareDiff > array |
page |
样例 : |
integer (int32) |
total |
样例 : |
integer (int32) |
PortAndView
名称 | 说明 | 类型 |
---|---|---|
elevation |
样例 : |
number (double) |
outline |
样例 : |
< number (double) > array |
viewId |
样例 : |
string |
viewPoint |
样例 : ViewPoint |
|
viewType |
样例 : |
string |
viewport |
样例 : |
< number (double) > array |
Preview
名称 | 说明 | 类型 |
---|---|---|
height |
样例 : |
integer (int32) |
path |
样例 : |
string |
width |
样例 : |
integer (int32) |
Property
名称 | 说明 | 类型 |
---|---|---|
boundingBox |
样例 : BoundingBox |
|
elementId |
样例 : |
string |
familyGuid |
样例 : |
string |
guid |
样例 : |
string |
name |
样例 : |
string |
properties |
样例 : |
< PropertyGroup > array |
PropertyGroup
名称 | 说明 | 类型 |
---|---|---|
group |
样例 : |
string |
items |
样例 : |
< PropertyItem > array |
PropertyItem
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
extension |
样例 : |
object |
key |
样例 : |
string |
unit |
样例 : |
string |
value |
样例 : |
object |
valueType |
样例 : |
integer (int32) |
PropertyValuesResp
名称 | 说明 | 类型 |
---|---|---|
property |
样例 : |
string |
values |
样例 : |
< object > array |
Quantity
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
desc |
样例 : |
string |
name |
样例 : |
string |
qty |
样例 : |
integer (int32) |
unit |
样例 : |
string |
RfaFamilyType
名称 | 说明 | 类型 |
---|---|---|
familyTypeGuid |
样例 : |
string |
name |
样例 : |
string |
RfaFamilyTypeProperty
名称 | 说明 | 类型 |
---|---|---|
familyTypeId |
样例 : |
string |
name |
样例 : |
string |
properties |
样例 : |
< PropertyGroup > array |
Room
名称 | 说明 | 类型 |
---|---|---|
area |
样例 : |
number (double) |
bboxMax |
样例 : Coordinate |
|
bboxMin |
样例 : Coordinate |
|
boundary |
样例 : |
string |
id |
样例 : |
string |
levelId |
样例 : |
string |
maxPt |
样例 : Coordinate |
|
minPt |
样例 : Coordinate |
|
name |
样例 : |
string |
perimeter |
样例 : |
number (double) |
properties |
样例 : |
< PropertyGroup > array |
RoomWithElementIdFileIds
名称 | 说明 | 类型 |
---|---|---|
area |
样例 : |
number (double) |
bboxMax |
样例 : Coordinate |
|
bboxMin |
样例 : Coordinate |
|
boundary |
样例 : |
string |
elementIdWithFileIds |
样例 : |
< ElementIdWithFileId > array |
id |
样例 : |
string |
levelId |
样例 : |
string |
maxPt |
样例 : Coordinate |
|
minPt |
样例 : Coordinate |
|
name |
样例 : |
string |
perimeter |
样例 : |
number (double) |
properties |
样例 : |
< PropertyGroup > array |
RoomWithElementIds
名称 | 说明 | 类型 |
---|---|---|
area |
样例 : |
number (double) |
bboxMax |
样例 : Coordinate |
|
bboxMin |
样例 : Coordinate |
|
boundary |
样例 : |
string |
elementIds |
样例 : |
< object > array |
id |
样例 : |
string |
levelId |
样例 : |
string |
maxPt |
样例 : Coordinate |
|
minPt |
样例 : Coordinate |
|
name |
样例 : |
string |
perimeter |
样例 : |
number (double) |
properties |
样例 : |
< PropertyGroup > array |
SearchAreaIdsResp
名称 | 说明 | 类型 |
---|---|---|
areaIds |
样例 : |
< object > array |
targetId |
样例 : |
string |
SearchElementIdsResp
名称 | 说明 | 类型 |
---|---|---|
elementIds |
样例 : |
< object > array |
targetId |
样例 : |
string |
SearchRoomIdsResp
名称 | 说明 | 类型 |
---|---|---|
roomIds |
样例 : |
< object > array |
targetId |
样例 : |
string |
SegmentDto
名称 | 说明 | 类型 |
---|---|---|
buildingId |
样例 : |
string |
code |
样例 : |
string |
createTime |
样例 : |
integer (int64) |
elementIds |
样例 : |
< string > array |
endElevation |
样例 : |
number |
endFloorId |
样例 : |
string |
floorIds |
样例 : |
< string > array |
id |
样例 : |
string |
integrateId |
样例 : |
integer (int64) |
isRelatedEdo |
样例 : |
boolean |
name |
样例 : |
string |
orderNo |
样例 : |
integer (int32) |
remark |
样例 : |
string |
segmentGroupId |
样例 : |
string |
specialtyId |
样例 : |
string |
startElevation |
样例 : |
number |
startFloorId |
样例 : |
string |
updateTime |
样例 : |
integer (int64) |
SegmentGroupDto
名称 | 说明 | 类型 |
---|---|---|
buildingId |
样例 : |
string |
code |
样例 : |
string |
createTime |
样例 : |
integer (int64) |
floorId |
样例 : |
string |
id |
样例 : |
string |
integrateId |
样例 : |
integer (int64) |
name |
样例 : |
string |
orderNo |
样例 : |
integer (int32) |
parentId |
样例 : |
string |
remark |
样例 : |
string |
segments |
样例 : |
< SegmentDto > array |
specialtyId |
样例 : |
string |
subGroups |
样例 : |
< SegmentGroupDto > array |
type |
样例 : |
integer (int32) |
updateTime |
样例 : |
integer (int64) |
SingleModelElementsSwaggerDisplay
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
data |
样例 : |
string |
message |
样例 : |
string |
SpecialtyNode
名称 | 说明 | 类型 |
---|---|---|
categories |
样例 : |
< CategoryNode > array |
itemCount |
样例 : |
integer (int32) |
specialtyId |
样例 : |
string |
specialtyName |
样例 : |
string |
TreeNode
名称 | 说明 | 类型 |
---|---|---|
actualName |
样例 : |
string |
data |
样例 : |
object |
elementCount |
样例 : |
integer (int32) |
id |
样例 : |
string |
items |
样例 : |
< TreeNode > array |
name |
样例 : |
string |
type |
样例 : |
string |
TreeNodeSort
名称 | 说明 | 类型 |
---|---|---|
nodeType |
样例 : |
enum (specialty, systemType, floor, category, family, familyType, building, unit) |
sortBy |
样例 : |
string |
sortedValues |
样例 : |
< string > array |
View
名称 | 说明 | 类型 |
---|---|---|
cropBox |
样例 : |
< object > array |
elevation |
样例 : |
number (double) |
id |
样例 : |
string |
levelId |
样例 : |
string |
name |
样例 : |
string |
outline |
样例 : |
< object > array |
preview |
样例 : Preview |
|
thumbnails |
样例 : |
< object > array |
viewPoint |
样例 : ViewPoint |
|
viewType |
样例 : |
string |