BIMFACE服务器端API接口

离线数据包相关

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

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

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

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

通过传入相应的ID创建对应离线数据包:
文件转换ID：PUT  https://api.bimface.com/files/{fileId}/offlineDatabag
集成模型ID：PUT  https://api.bimface.com/integrations/{integrateId}/offlineDatabag
模型对比ID：PUT  https://api.bimface.com/comparisions/{compareId}/offlineDatabag
文件转换、集成或对比成功后，即可创建该文件的离线数据包。 BIMFACE支持在创建离线数据包完成以后，通过Callback机制通知调用方(请参考这里)；另外，调用方也可以通过接口查询离线数据包状态。 
若需要离线数据包保留db文件，请求体中参数设置为
{
  "config": {
    "keepModel": true,
    "keepDB": true
  }
}
在生成的离线数据包中，db文件的存储路径为
offline databag db

文件ID创建离线数据包

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

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

integer (int64)

Query

callback
可选

回调url

string

Body

request
可选

DatabagDerivativeRequest请求体
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

fileId

Long

文件转换Id

8167234891

databagVersion

String

离线包版本

2.0

status

String

离线包状态

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

reason

String

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

…

createTime

String

离线包生成时间

2016-08-08 12:36:47
失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

file.not.found

文件不存在

file.not.translated

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

file.translating

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

file.translate.failure

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

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

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

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

integer (int64)

Query

callback
可选

回调url

string

Body

request
可选

DatabagDerivativeRequest请求体
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

integrateId

Long

集成模型ID

8167234891

databagVersion

String

离线包版本

2.0

status

String

离线包状态

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

reason

String

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

…

createTime

String

离线包生成时间

2016-08-08 12:36:47
失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

integration.not.found

集成模型未找到

integration.not.translated

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

integration.translating

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

integration.translate.failure

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

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

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

compareId
必填

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

integer (int64)

Query

callback
可选

回调url

string

Body

request
可选

DatabagDerivativeRequest请求体
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

compareId

Long

对比模型ID

8167234891

databagVersion

String

离线包版本

2.0

status

String

离线包状态

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

reason

String

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

…

createTime

String

离线包生成时间

2016-08-08 12:36:47
失败返回
{
    "code": "authentication.failed",
    "message": "Token was not recognized."
}
错误码
code 说明

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

compare.not.found

对比文件未找到

compare.not.translated

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

compare.translating

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

compare.translate.failure

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

查询文件离线数据包

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

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

integer (int64)
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

查询模型对比离线数据包

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

compareId
必填

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

integer (int64)
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

查询集成模型离线数据包

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

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

integer (int64)
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取数据包下载地址

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

compareId
可选

模型对比ID

integer (int64)

Query

databagVersion
可选

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

string

Query

fileId
可选

代表单模型的文件ID

integer (int64)

Query

integrateId
可选

集成模型ID

integer (int64)

Query

type
可选

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

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

数据实体类

AccessTokenBean

名称 说明 类型

expireTime
可选

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

string

token
可选

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

string

BakeDatabagInfo

名称 说明 类型

databagId
可选

样例 : "e38e93beb3204a909969e3e24f7e24f3"

string

databagVersion
可选

样例 : "databagVersion"

string

modelId
可选

样例 : 0

integer (int64)

originalDatabagId
可选

样例 : "98612d59621f4c44be96264d4e642375"

string

status
可选

样例 : "status"

string

BatchDeleteResultBean«long»

名称 说明 类型

deleted
可选

样例 : [ 0 ]

< integer (int64) > array

nonexistence
可选

样例 : [ 0 ]

< integer (int64) > array

BusinessAssociationBean

名称 说明 类型

associationId
可选

样例 : 1469060916315200

integer (int64)

config
可选

样例 : "object"

object

createTime
可选

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

string

integrateId
可选

样例 : 133542854

integer (int64)

name
可选

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

string

reason
可选

样例 : "reason"

string

ruleFileIds
可选

样例 : [ 0 ]

< integer (int64) > array

sourceId
可选

样例 : "1469060916315200"

string

status
可选

样例 : "success"

string

BusinessAssociationRequest

名称 说明 类型

callback
可选

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

string

config
可选

样例 : "object"

object

integrateId
可选

样例 : 133542854

integer (int64)

name
可选

样例 : "purchaseProduct222230"

string

ruleFileIds
可选

样例 : [ 1223122 ]

< object > array

sourceId
可选

样例 : "1469060916315200"

string

CompareRequest

名称 说明 类型

callback
可选

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

string

comparedEntityType
可选

样例 : "file"

string

config
可选

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

< string, string > map

followingId
可选

样例 : 22145522

integer (int64)

name
可选

样例 : "compare0001"

string

previousId
可选

样例 : 12311221

integer (int64)

sourceId
可选

样例 : "123223223212"

string

DatabagDerivativeBean

名称 说明 类型

createTime
可选

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

string

databagVersion
可选

样例 : "3.1"

string

length
可选

样例 : 0

integer (int64)

reason
可选

样例 : "reason"

string

status
可选

样例 : "success"

string

DatabagDerivativeRequest

名称 说明 类型

config
可选

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

< string, string > map

Diff

名称 说明 类型

next
可选

样例 : 0

integer (int64)

prev
可选

样例 : 0

integer (int64)

ElementPropertyOverride

名称 说明 类型

keyToMatch
可选

样例 : "system_type"

string

keyToOverride
可选

样例 : "specialty"

string

targetFileIds
可选

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

< object > array

valueOverrides
可选

ElementPropertyValueOverride

名称 说明 类型

valueToMatch
可选

样例 : "water_support_pipe"

string

valueToOverride
可选

样例 : "water_support"

string

EventTrackingRequest

名称 说明 类型

events
可选

样例 : [ "string" ]

< string > array

FileIntegrateBean

名称 说明 类型

createTime
可选

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

string

integrateId
可选

样例 : 1248789977538784

integer (int64)

name
可选

样例 : "integrate-x"

string

reason
可选

样例 : "reason"

string

sourceId
可选

样例 : "123156522123"

string

status
可选

样例 : "success"

string

thumbnail
可选

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

< object > array

type
可选

样例 : "type"

string

FileIntegrateDetailBean

名称 说明 类型

cost
可选

样例 : 0

integer (int32)

createTime
可选

样例 : "createTime"

string

databagId
可选

样例 : "8307d4628e6b4ffaa45747b0ae3a25e5"

string

integrateId
可选

样例 : 0

integer (int64)

name
可选

样例 : "name"

string

offlineDatabagStatus
可选

样例 : "offlineDatabagStatus"

string

reason
可选

样例 : "reason"

string

shareToken
可选

样例 : "shareToken"

string

shareUrl
可选

样例 : "shareUrl"

string

sourceId
可选

样例 : "4de13d5dc8a948f1b661999a44584654"

string

status
可选

样例 : "status"

string

thumbnail
可选

样例 : [ "string" ]

< string > array

type
可选

样例 : "type"

string

workerType
可选

样例 : "workerType"

string

FileIntegrateRequest

名称 说明 类型

callback
可选

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

string

config
可选

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

< string, string > map

floorMapping
可选

样例 : [ "FloorMappingItem" ]

< FloorMappingItem > array

floorSort
可选

样例 : [ "5" ]

< string > array

internalConfigMap
可选

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

< string, string > map

name
可选

样例 : "model.rvt"

string

parentIntegrateId
可选

样例 : 0

integer (int64)

propertyOverrides
可选

样例 : [ "ElementPropertyOverride" ]

ruleFileIds
可选

样例 : [ 1232134213412 ]

< object > array

sourceId
可选

样例 : "hduf2w3ho21nowr23rqwjrn2o3"

string

sources
可选

样例 : [ "IntegrateSource" ]

< IntegrateSource > array

specialtySort
可选

样例 : [ "2" ]

< string > array

FileTranslateBean

名称 说明 类型

createTime
可选

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

string

databagId
可选

样例 : "9b711803a43b92d871cde346b63e5019"

string

fileId
可选

样例 : 1248789071339712

integer (int64)

name
可选

样例 : "bimface_2018.rvt"

string

reason
可选

样例 : "reason"

string

status
可选

样例 : "success"

string

thumbnail
可选

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

< object > array

FileTranslateDetailBean

名称 说明 类型

appKey
可选

样例 : "appKey"

string

cost
可选

样例 : 0

integer (int32)

createTime
可选

样例 : "createTime"

string

databagId
可选

样例 : "498bc694854244abab728b20620cbaf9"

string

fileId
可选

样例 : 0

integer (int64)

length
可选

样例 : 0

integer (int64)

name
可选

样例 : "name"

string

offlineDatabagStatus
可选

样例 : "offlineDatabagStatus"

string

reason
可选

样例 : "reason"

string

retry
可选

样例 : true

boolean

shareToken
可选

样例 : "shareToken"

string

shareUrl
可选

样例 : "shareUrl"

string

sourceId
可选

样例 : "d69620720c63480c9f4808bf442ed96a"

string

status
可选

样例 : "status"

string

supportOfflineDatabag
可选

样例 : true

boolean

thumbnail
可选

样例 : [ "string" ]

< string > array

type
可选

样例 : "type"

string

FileTranslateRequest

名称 说明 类型

callback
可选

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

string

config
可选

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

< string, string > map

source
可选

样例 : TranslateSource

FloorMappingItem

名称 说明 类型

fileFloorId
可选

样例 : "pj1101"

string

projectFloorId
可选

样例 : "pj11"

string

projectFloorName
可选

样例 : "firstfloor"

string

GeneralResponse

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«AccessTokenBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : AccessTokenBean

message
可选

样例 : ""

string

GeneralResponse«BatchDeleteResultBean«long»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«BusinessAssociationBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«DatabagDerivativeBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«FileIntegrateBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«FileTranslateBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«InsecureShareLinkBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«DatabagDerivativeBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DatabagDerivativeBean" ]

message
可选

样例 : ""

string

GeneralResponse«List«ProjectIntegrateBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ProjectIntegrateBean" ]

message
可选

样例 : ""

string

GeneralResponse«List«ProjectOperationBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ProjectOperationBean" ]

message
可选

样例 : ""

string

GeneralResponse«ModelCompareBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ModelCompareBean

message
可选

样例 : ""

string

GeneralResponse«ModelVersionInfo»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ModelVersionInfo

message
可选

样例 : ""

string

GeneralResponse«PagedList«FileIntegrateDetailBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«PagedList«FileTranslateDetailBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«PagedList«ModelCompareBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«PagedList«ShareLinkBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«ProjectBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ProjectBean

message
可选

样例 : ""

string

GeneralResponse«ShareLinkBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ShareLinkBean

message
可选

样例 : ""

string

GeneralResponse«boolean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : true

boolean

message
可选

样例 : ""

string

GeneralResponse«string»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "data"

string

message
可选

样例 : ""

string

InsecureShareLinkBean

名称 说明 类型

appKey
可选

样例 : "appKey"

string

expireTime
可选

样例 : "expireTime"

string

passwordProtect
可选

样例 : true

boolean

sourceId
可选

样例 : 0

integer (int64)

sourceType
可选

样例 : "sourceType"

string

url
可选

样例 : "url"

string

IntegrateDrawingsInfo

名称 说明 类型

databagId
可选

样例 : "301a9a3b54a94eacb1806baf33e3818f"

string

databagVersion
可选

样例 : "databagVersion"

string

drawingIntegrateId
可选

样例 : 0

integer (int64)

status
可选

样例 : "status"

string

IntegrateQueryRequest

名称 说明 类型

appKey
可选

样例 : "appKey"

string

endDate
可选

样例 : "string"

string (date-time)

fileName
可选

样例 : "fileName"

string

integrateId
可选

样例 : 0

integer (int64)

integrateType
可选

样例 : "integrateType"

string

pageNo
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

sortType
可选

样例 : "sortType"

string

sourceId
可选

样例 : "cdcd16c9e63f445eb48ccc983dde3d35"

string

startDate
可选

样例 : "string"

string (date-time)

status
可选

样例 : 0

integer (int32)

IntegrateSource

名称 说明 类型

building
可选

样例 : "GlodonBuilding"

string

databagId
可选

样例 : "h2h2312223"

string

fileId
可选

样例 : 12311221

integer (int64)

fileName
可选

样例 : "model.rvt"

string

floor
可选

样例 : "F01"

string

floorSort
可选

样例 : 0.1

number (float)

specialty
可选

样例 : "AR"

string

specialtySort
可选

样例 : 0.1

number (float)

transform
可选

样例 : [ 1.23 ]

< number (double) > array

ModelAndView

名称 说明 类型

empty
可选

样例 : true

boolean

model
可选

样例 : "object"

object

modelMap
可选

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

< string, object > map

reference
可选

样例 : true

boolean

status
可选

样例 : "string"

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

view
可选

样例 : View

viewName
可选

样例 : "string"

string

ModelCompareBean

名称 说明 类型

compareId
可选

样例 : 1248756572307264

integer (int64)

cost
可选

样例 : 0

integer (int32)

createTime
可选

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

string

name
可选

样例 : "compare0001"

string

offlineDatabagStatus
可选

样例 : "offlineDatabagStatus"

string

reason
可选

样例 : "reason"

string

sourceId
可选

样例 : "123223223212"

string

status
可选

样例 : "succcess"

string

thumbnail
可选

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

< object > array

type
可选

样例 : "type"

string

workerType
可选

样例 : "workerType"

string

ModelCompareItem

名称 说明 类型

followingDatabagId
可选

样例 : "f3323ff221"

string

followingFileId
可选

样例 : 22145522

integer (int64)

followingFileName
可选

样例 : "folModel0001"

string

previousDatabagId
可选

样例 : "h2h2312223"

string

previousFileId
可选

样例 : 12311221

integer (int64)

previousFileName
可选

样例 : "preModel0001"

string

ModelCompareQueryRequest

名称 说明 类型

appKey
可选

样例 : "appKey"

string

compareId
可选

样例 : 0

integer (int64)

endDate
可选

样例 : "string"

string (date-time)

fileName
可选

样例 : "fileName"

string

pageNo
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

sortType
可选

样例 : "sortType"

string

sourceId
可选

样例 : "23be51b7e1eb4228bd896ac1a4640c62"

string

startDate
可选

样例 : "string"

string (date-time)

status
可选

样例 : 0

integer (int32)

type
可选

样例 : "type"

string

ModelCompareRequest

名称 说明 类型

callback
可选

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

string

name
可选

样例 : "compare0001"

string

sourceId
可选

样例 : "123223223212"

string

sources
可选

样例 : [ "ModelCompareItem" ]

< ModelCompareItem > array

ModelVersionInfo

名称 说明 类型

bake
可选

样例 : BakeDatabagInfo

config
可选

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

< string, string > map

databagId
可选

样例 : "8636a4058e7aaea4dfa4ecd769c9e44a"

string

integrateDrawings
可选

isSupportComponentProperty
可选

样例 : false

boolean

isSupportDrawing
可选

样例 : false

boolean

isSupportFamilyTypeList
可选

样例 : false

boolean

isSupportMaterialProperty
可选

样例 : false

boolean

isSupportMiniMap
可选

样例 : false

boolean

isSupportModelTree
可选

样例 : false

boolean

isSupportRoomArea
可选

样例 : false

boolean

isSupportWalk
可选

样例 : true

boolean

jsSDKVersion
可选

样例 : "Drawing@1.4.21"

string

modelId
可选

样例 : 1442677445091680

integer (int64)

modelType
可选

样例 : "singleModel"

string

name
可选

样例 : "name"

string

renderType
可选

样例 : "drawingView"

string

renderVersion
可选

样例 : "1.0"

string

subRenders
可选

样例 : [ "RenderInfo" ]

< RenderInfo > array

type
可选

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

integer (int32)

workerType
可选

样例 : "dwg-transfer"

string

Page

名称 说明 类型

htmlDisplay
可选

样例 : "string"

string

nextPage
可选

样例 : 0

integer (int32)

pageNo
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

prePage
可选

样例 : 0

integer (int32)

startIndex
可选

样例 : 0

integer (int32)

totalCount
可选

样例 : 0

integer (int32)

totalPages
可选

样例 : 0

integer (int32)

PagedList«FileIntegrateDetailBean»

名称 说明 类型

list
可选

样例 : [ "FileIntegrateDetailBean" ]

page
可选

样例 : Page

PagedList«FileTranslateDetailBean»

名称 说明 类型

list
可选

样例 : [ "FileTranslateDetailBean" ]

page
可选

样例 : Page

PagedList«ModelCompareBean»

名称 说明 类型

list
可选

样例 : [ "ModelCompareBean" ]

< ModelCompareBean > array

page
可选

样例 : Page

PagedList«ShareLinkBean»

名称 说明 类型

list
可选

样例 : [ "ShareLinkBean" ]

< ShareLinkBean > array

page
可选

样例 : Page

ProjectBean

名称 说明 类型

createTime
可选

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

string

id
可选

样例 : 1482883097924832

integer (int64)

integrateId
可选

样例 : 1482282416739552

integer (int64)

integrateStatus
可选

样例 : "processing"

string

name
可选

样例 : "projectReplaceIntegrateIgms_1542769436014"

string

ProjectCreateRequest

名称 说明 类型

callback
可选

样例 : "callback-project-create"

string

integrate
可选

materialOverrideSetFileId
可选

样例 : 1848927668131

integer (int64)

metaFileId
可选

样例 : 12133321212

integer (int64)

name
可选

样例 : "projectReplaceIntegrateIgms_1542769436014"

string

segmentFileId
可选

样例 : 1947792131

integer (int64)

ProjectIntegrateBean

名称 说明 类型

active
可选

样例 : false

boolean

createTime
可选

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

string

integrateId
可选

样例 : 1482886825563360

integer (int64)

parentIntegrateId
可选

样例 : 5632012478745400

integer (int64)

status
可选

样例 : "success"

string

ProjectModifyRequest

名称 说明 类型

addedFileIds
可选

样例 : [ 1741234213423 ]

< object > array

callback
可选

样例 : "callback-project-modify"

string

changedFileIds
可选

样例 : [ "Diff" ]

< Diff > array

deletedFileIds
可选

样例 : [ 17319741934123 ]

< object > array

materialOverrideSetFileId
可选

样例 : 1734092134

integer (int64)

metaFileId
可选

样例 : 2374892141

integer (int64)

segmentFileId
可选

样例 : 1347784336780608

integer (int64)

transformMap
可选

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

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

ProjectOperationBean

名称 说明 类型

addedFiles
可选

样例 : ""

string

callbackStatus
可选

样例 : "null"

integer (int32)

callbackTimes
可选

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

integer (int32)

callbackUrl
可选

样例 : "callback-project-operation"

string

changedFiles
可选

样例 : ""

string

createTime
可选

样例 : 1542701893000

integer (int64)

deletedFiles
可选

样例 : ""

string

id
可选

样例 : 1482330998494432

integer (int64)

integrate
可选

样例 : true

boolean

jobId
可选

样例 : 1482331457975328

integer (int64)

jobSourceId
可选

样例 : 1482331455999008

integer (int64)

metaFileId
可选

样例 : 1231231231231230

integer (int64)

mosFileId
可选

样例 : 1000100010001

integer (int64)

projectId
可选

样例 : 1482327255430368

integer (int64)

segmentFileId
可选

样例 : 2000200020002

integer (int64)

status
可选

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

integer (int32)

transform
可选

样例 : "transform"

string

workerCode
可选

样例 : "send.job.failed"

string

workerMessage
可选

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

string

ProjectOperationFixRequest

名称 说明 类型

callback
可选

样例 : "callback-project-fix"

string

replaceFileMap
可选

样例 : { "string" : 0 }

< string, integer (int64) > map

transformMap
可选

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

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

RenderInfo

名称 说明 类型

isSupportComponentProperty
可选

样例 : true

boolean

isSupportFamilyTypeList
可选

样例 : true

boolean

isSupportMiniMap
可选

样例 : true

boolean

isSupportModelTree
可选

样例 : true

boolean

jsSDKVersion
可选

样例 : "Drawing@1.3.357"

string

renderType
可选

样例 : "drawingView"

string

renderVersion
可选

样例 : "1.0"

string

ShareLinkBean

名称 说明 类型

appKey
可选

样例 : "appKey"

string

expireTime
可选

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

string

password
可选

样例 : "sdfgth"

string

sourceId
可选

样例 : 1234567890987

integer (int64)

sourceName
可选

样例 : "1206075470044992"

string

sourceType
可选

样例 : "1"

string

url
可选

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

string

TranslateQueryRequest

名称 说明 类型

appKey
可选

样例 : "appKey"

string

endDate
可选

样例 : "string"

string (date-time)

fileId
可选

样例 : 0

integer (int64)

fileName
可选

样例 : "fileName"

string

pageNo
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

sortType
可选

样例 : "sortType"

string

sourceId
可选

样例 : "d4649ee227e345c8b7f0022342247dec"

string

startDate
可选

样例 : "string"

string (date-time)

status
可选

样例 : 0

integer (int32)

suffix
可选

样例 : "suffix"

string

TranslateSource

名称 说明 类型

compressed
可选

样例 : false

boolean

fileId
可选

样例 : 1277823232112

integer (int64)

rootName
可选

样例 : "rootFileName.rvt"

string

View

名称 说明 类型

contentType
可选

样例 : "string"

string

AggregationNode

名称 说明 类型

attachment
可选

样例 : "attachment"

string

children
可选

样例 : [ "AggregationNode" ]

< AggregationNode > array

id
可选

样例 : "32c1e398a39a4f1d8b4f19afba9496c8"

string

innerEntType
可选

样例 : "string"

enum (zsk)

name
可选

样例 : "name"

string

quantity
可选

样例 : 0.0

number (double)

sortAttachment
可选

样例 : "sortAttachment"

string

type
可选

样例 : "string"

enum (floor, category, family, familyType, room, quantityCode, subFamilyType, zsk)

unit
可选

样例 : "unit"

string

AggregationResult

名称 说明 类型

aggregations
可选

样例 : [ "AggregationNode" ]

< AggregationNode > array

familyQtyOrders
可选

样例 : [ [ "string" ] ]

< < string > array > array

Area

名称 说明 类型

area
可选

样例 : 5.168684733047761E7

number (double)

boundary
可选

样例 : ""

string

id
可选

样例 : "313137"

string

levelId
可选

样例 : "11"

string

maxPt
可选

样例 : Coordinate

minPt
可选

样例 : Coordinate

name
可选

样例 : "dining room 4"

string

perimeter
可选

样例 : 28802.013920728663

number (double)

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

viewName
可选

样例 : "1 1"

string

Attribute

名称 说明 类型

key
可选

样例 : "key"

string

unit
可选

样例 : "unit"

string

value
可选

样例 : "value"

string

BarQuantityItem

名称 说明 类型

desc
可选

样例 : "desc"

string

name
可选

样例 : "name"

string

quantity
可选

样例 : 0.0

number (float)

BarQuantityVO

名称 说明 类型

barQuantities
可选

样例 : [ "BarQuantityItem" ]

< BarQuantityItem > array

elementId
可选

样例 : "1873264"

string

floor
可选

样例 : "floor"

string

floorId
可选

样例 : "1deeea3424ad424b9f1829c5fda5d20b"

string

name
可选

样例 : "name"

string

BoundingBox

名称 说明 类型

max
可选

样例 : Coordinate

min
可选

样例 : Coordinate

BoundingBox2D

名称 说明 类型

max
可选

样例 : Coordinate2D

min
可选

样例 : Coordinate2D

BusinessAssociation

名称 说明 类型

businessFlag
可选

样例 : "flag_test"

string

businessId
可选

样例 : "1299507310231776"

string

businessType
可选

样例 : "type_test"

string

elementId
可选

样例 : "12321"

string

BusinessAssociationRequest

名称 说明 类型

associations
可选

样例 : [ "BusinessAssociation" ]

businessFlag
可选

样例 : "flag_test"

string

businessType
可选

样例 : "type_test"

string

BusinessElementAssociation

名称 说明 类型

businessFlag
可选

样例 : "flag_test"

string

businessId
可选

样例 : "1299507310231776"

string

businessType
可选

样例 : "type_test"

string

elementIds
可选

样例 : [ "12321" ]

< object > array

integrateId
可选

样例 : "1299498154893536"

string

CategoryNode

名称 说明 类型

categoryId
可选

样例 : "c47891beb8454dbca437a430fdbc2a19"

string

categoryName
可选

样例 : "categoryName"

string

elements
可选

样例 : [ "ElementNode" ]

< ElementNode > array

itemCount
可选

样例 : 0

integer (int32)

Changed«Attribute»

名称 说明 类型

_A
可选

样例 : Attribute

_B
可选

样例 : Attribute

Changed«Quantity»

名称 说明 类型

_A
可选

样例 : Quantity

_B
可选

样例 : Quantity

Coordinate

名称 说明 类型

x
可选

样例 : -4938.068482562385

number (double)

y
可选

样例 : -3201.59397858169

number (double)

z
可选

样例 : 0.0

number (double)

Coordinate2D

名称 说明 类型

x
可选

样例 : 0.0

number (double)

y
可选

样例 : 0.0

number (double)

CustomizedTree

名称 说明 类型

item
可选

样例 : CustomizedTree

type
可选

样例 : "specialty"

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

DatabagInfo

名称 说明 类型

length
可选

样例 : 0

integer (int64)

DatabagResourceRequest

名称 说明 类型

resources
可选

样例 : "ModelTree"

< string > array

DatabagResourceUrl

名称 说明 类型

resource
可选

样例 : "ModelTree"

string

url
可选

样例 : "https://bf-dev-srcfile.oss-cn-shanghai.aliyuncs.com/9b711803a43b92d871cde346b63e5019/data/tree.json?OSSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1626075962&Signature=E962TFCV36hvLaERGI9h2K6fyTQ%3D"

string

DrawingCompareDiff

名称 说明 类型

diffType
可选

样例 : "diffType"

string

id
可选

样例 : "30882145375847a18750c66b25407dae"

string

layer
可选

样例 : "layer"

string

DrawingFileInfo

名称 说明 类型

drawingId
可选

样例 : "bbea08f9ebd941e984a35ad84ae5a183"

string

drawingName
可选

样例 : "drawingName"

string

fileId
可选

样例 : "1223445667788"

string

DrawingFrame

名称 说明 类型

boundingBox
可选

样例 : BoundingBox2D

id
可选

样例 : 0

integer (int64)

name
可选

样例 : "name"

string

number
可选

样例 : "number"

string

DrawingSheet

名称 说明 类型

fileId
可选

样例 : 0

integer (int64)

portsAndViews
可选

样例 : [ "PortAndView" ]

< PortAndView > array

viewInfo
可选

样例 : View

DrawingSplitLayout

名称 说明 类型

frames
可选

样例 : [ "DrawingFrame" ]

< DrawingFrame > array

id
可选

样例 : 0

integer (int64)

name
可选

样例 : "name"

string

ElementBusinessAssociation

名称 说明 类型

businessFlag
可选

样例 : "flag_test"

string

businessIds
可选

样例 : [ "1299507310231776" ]

< object > array

businessType
可选

样例 : "type_test"

string

elementId
可选

样例 : "12321"

string

integrateId
可选

样例 : "1299498154893536"

string

ElementIdWithBoundingBox

名称 说明 类型

boundingBox
可选

样例 : BoundingBox

elementId
可选

样例 : "313052"

string

ElementIdWithFileId

名称 说明 类型

elementId
可选

样例 : "313052"

string

fileId
可选

样例 : "cce34cec5412bfdb412b97d4fd0b30ec"

string

ElementIdWithName

名称 说明 类型

elementId
可选

样例 : "1873264"

string

name
可选

样例 : "name"

string

ElementNode

名称 说明 类型

diffType
可选

样例 : "string"

enum (new, delete, change)

followingElementId
可选

样例 : "af07364e16b246d1bdd032c4d37e02d0"

string

followingFileId
可选

样例 : "1fa38420a11b4f65a8a5723892431f6e"

string

name
可选

样例 : "name"

string

previousElementId
可选

样例 : "d87af2d3c563435ab85755ee279d073e"

string

previousFileId
可选

样例 : "f720c2d42a0141fca51cb24c67bf8712"

string

ElementPropertyFilterRequest

名称 说明 类型

elementIds
可选

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

< string > array

filter
可选

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

< GroupAndKeysPair > array

ElementQuantityChild

名称 说明 类型

elementId
可选

样例 : "1873264"

string

elementQuantities
可选

样例 : [ "ElementQuantityItem" ]

name
可选

样例 : "name"

string

ElementQuantityItem

名称 说明 类型

code
可选

样例 : "code"

string

quantity
可选

样例 : 0.0

number (float)

ElementQuantitySchemaItem

名称 说明 类型

code
可选

样例 : "code"

string

name
可选

样例 : "name"

string

ElementQuantityVO

名称 说明 类型

children
可选

样例 : [ "ElementQuantityChild" ]

elementId
可选

样例 : "1873264"

string

elementQuantities
可选

样例 : [ "ElementQuantityItem" ]

floor
可选

样例 : "floor"

string

floorId
可选

样例 : "0a6ac0bc477749f09434c2115255de0d"

string

name
可选

样例 : "name"

string

ElementsTreeRequest

名称 说明 类型

elements
可选

样例 : [ "ElementIdWithFileId" ]

hierarchy
可选

样例 : [ "CustomizedTree" ]

< CustomizedTree > array

ElementsWithBoundingBox

名称 说明 类型

boundingBox
可选

样例 : BoundingBox

elements
可选

样例 : [ "ElementIdWithFileId" ]

FileIdHashWithElementIds

名称 说明 类型

elementIds
可选

样例 : [ "1109329", "1109300" ]

< object > array

fileIdHash
可选

样例 : "1365346274583424"

string

FileTreeRequestBody

名称 说明 类型

customizedNodeKeys
可选

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

< string, string > map

desiredHierarchy
可选

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

< object > array

FileViews

名称 说明 类型

fileId
可选

样例 : 1280438635534016

integer (int64)

views
可选

样例 : [ "View" ]

< View > array

FileWithDrawingSheets

名称 说明 类型

drawingSheets
可选

样例 : [ "DrawingSheet" ]

< DrawingSheet > array

fileId
可选

样例 : "1477981195354592"

string

fileName
可选

样例 : "A2-1030.rvt"

string

Floor

名称 说明 类型

archElev
可选

样例 : 0.0

number (float)

areas
可选

样例 : [ "ObjectOnFloor" ]

< ObjectOnFloor > array

elevation
可选

样例 : 0.0

number (float)

height
可选

样例 : 4000.0

number (float)

id
可选

样例 : "311"

string

miniMap
可选

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

string

name
可选

样例 : "elevation 1"

string

rooms
可选

样例 : [ "ObjectOnFloor" ]

< ObjectOnFloor > array

structElev
可选

样例 : 0.0

number (float)

GeneralResponse

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«AggregationResult»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«Area»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : Area

message
可选

样例 : ""

string

GeneralResponse«BarQuantityVO»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : BarQuantityVO

message
可选

样例 : ""

string

GeneralResponse«DatabagInfo»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : DatabagInfo

message
可选

样例 : ""

string

GeneralResponse«ElementQuantityVO»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«ElementsWithBoundingBox»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«Area»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Area" ]

< Area > array

message
可选

样例 : ""

string

GeneralResponse«List«BusinessElementAssociation»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«DatabagResourceUrl»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DatabagResourceUrl" ]

< DatabagResourceUrl > array

message
可选

样例 : ""

string

GeneralResponse«List«DrawingFileInfo»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DrawingFileInfo" ]

< DrawingFileInfo > array

message
可选

样例 : ""

string

GeneralResponse«List«DrawingSheet»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DrawingSheet" ]

< DrawingSheet > array

message
可选

样例 : ""

string

GeneralResponse«List«DrawingSplitLayout»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "DrawingSplitLayout" ]

< DrawingSplitLayout > array

message
可选

样例 : ""

string

GeneralResponse«List«ElementBusinessAssociation»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«ElementIdWithBoundingBox»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ElementIdWithBoundingBox" ]

message
可选

样例 : ""

string

GeneralResponse«List«ElementIdWithName»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ElementIdWithName" ]

< ElementIdWithName > array

message
可选

样例 : ""

string

GeneralResponse«List«ElementQuantitySchemaItem»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ElementQuantitySchemaItem" ]

message
可选

样例 : ""

string

GeneralResponse«List«FileViews»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "FileViews" ]

< FileViews > array

message
可选

样例 : ""

string

GeneralResponse«List«FileWithDrawingSheets»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "FileWithDrawingSheets" ]

message
可选

样例 : ""

string

GeneralResponse«List«Floor»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Floor" ]

< Floor > array

message
可选

样例 : ""

string

GeneralResponse«List«IntegrateFileData»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "IntegrateFileData" ]

< IntegrateFileData > array

message
可选

样例 : ""

string

GeneralResponse«List«LinkGraphNode»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "LinkGraphNode" ]

< LinkGraphNode > array

message
可选

样例 : ""

string

GeneralResponse«List«Link»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Link" ]

< Link > array

message
可选

样例 : ""

string

GeneralResponse«List«MEPSystem»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "MEPSystem" ]

< MEPSystem > array

message
可选

样例 : ""

string

GeneralResponse«List«MaterialInfo»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "MaterialInfo" ]

< MaterialInfo > array

message
可选

样例 : ""

string

GeneralResponse«List«ModelCompareFileDiff»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "ModelCompareFileDiff" ]

message
可选

样例 : ""

string

GeneralResponse«List«PropertyValuesResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "PropertyValuesResp" ]

< PropertyValuesResp > array

message
可选

样例 : ""

string

GeneralResponse«List«Property»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Property" ]

< Property > array

message
可选

样例 : ""

string

GeneralResponse«List«IntegrateProperty»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "IntegrateProperty" ]

message
可选

样例 : ""

string

GeneralResponse«List«RfaFamilyType»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "RfaFamilyType" ]

< RfaFamilyType > array

message
可选

样例 : ""

string

GeneralResponse«List«RoomWithElementIdFileIds»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "RoomWithElementIdFileIds" ]

message
可选

样例 : ""

string

GeneralResponse«List«RoomWithElementIds»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "RoomWithElementIds" ]

< RoomWithElementIds > array

message
可选

样例 : ""

string

GeneralResponse«List«Room»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Room" ]

< Room > array

message
可选

样例 : ""

string

GeneralResponse«List«SearchAreaIdsResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SearchAreaIdsResp" ]

< SearchAreaIdsResp > array

message
可选

样例 : ""

string

GeneralResponse«List«SearchElementIdsResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SearchElementIdsResp" ]

message
可选

样例 : ""

string

GeneralResponse«List«SearchRoomIdsResp»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SearchRoomIdsResp" ]

< SearchRoomIdsResp > array

message
可选

样例 : ""

string

GeneralResponse«List«SegmentDto»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SegmentDto" ]

< SegmentDto > array

message
可选

样例 : ""

string

GeneralResponse«List«SegmentGroupDto»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SegmentGroupDto" ]

< SegmentGroupDto > array

message
可选

样例 : ""

string

GeneralResponse«List«SpecialtyNode»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "SpecialtyNode" ]

< SpecialtyNode > array

message
可选

样例 : ""

string

GeneralResponse«List«Tree»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "Tree" ]

< Tree > array

message
可选

样例 : ""

string

GeneralResponse«List«View»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "View" ]

< View > array

message
可选

样例 : ""

string

GeneralResponse«List«string»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "string" ]

< string > array

message
可选

样例 : ""

string

GeneralResponse«Map»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«MaterialOverrideSetVO»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«ModelCompareChange»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«Pagination«DrawingCompareDiff»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«Pagination«ModelCompareDiff»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«ParentAndSiblingElements»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«Property»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : Property

message
可选

样例 : ""

string

GeneralResponse«RfaFamilyTypeProperty»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«Room»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : Room

message
可选

样例 : ""

string

GeneralResponse«Tree»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : Tree

message
可选

样例 : ""

string

GeneralResponse«object»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«string»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "data"

string

message
可选

样例 : ""

string

GetUrlSwaggerDisplay

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "http://m.bimface.com/xxx.zip"

string

message
可选

样例 : "string"

string

GroupAndKeysPair

名称 说明 类型

group
可选

样例 : "group"

string

keys
可选

样例 : [ "string" ]

< string > array

IntegrateElementPropertyFilterRequest

名称 说明 类型

ids
可选

样例 : [ { "fileIdHash" : "1739317053179456", "elementIds" : [ "313154", "313047"] }]

filter
可选

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

IntegrateFileData

名称 说明 类型

databagId
可选

样例 : "3deff594b79348639ad5825e0d4914cb"

string

drawingSheetCount
可选

样例 : 0

integer (int32)

fileId
可选

样例 : 0

integer (int64)

fileName
可选

样例 : "fileName"

string

floor
可选

样例 : "floor"

string

floorSort
可选

样例 : 0.0

number (float)

integrateId
可选

样例 : 0

integer (int64)

linkedBy
可选

样例 : [ "string" ]

< string > array

specialty
可选

样例 : "specialty"

string

specialtySort
可选

样例 : 0.0

number (float)

IntegrationTreeOptionalRequestBody

名称 说明 类型

customizedNodeKeys
可选

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

< string, string > map

fileIdElementIds
可选

样例 : [ "ElementIdWithFileId" ]

sortedNamesHierarchy
可选

样例 : [ [ "string" ] ]

< < string > array > array

sorts
可选

样例 : [ "TreeNodeSort" ]

< TreeNodeSort > array

Link

名称 说明 类型

guid
可选

样例 : "ffb665b7-067f-4cd6-b080-214e96db0f73-00058185"

string

id
可选

样例 : 0

integer (int64)

name
可选

样例 : "file_link.rvt : 12 : loc <not shared>"

string

transform
可选

样例 : ""

string

LinkGraphNode

名称 说明 类型

databagId
可选

样例 : "a2b670bf1e8fd6471b92d90f16b170ad"

string

fileId
可选

样例 : "1315933894148640"

string

linkName
可选

样例 : "y.rvt: 7 : loc <not shared>"

string

linkPathHash
可选

样例 : "1315933894148640"

string

linkTransform
可选

样例 : ""

string

links
可选

样例 : [ "LinkGraphNode" ]

< LinkGraphNode > array

name
可选

样例 : "x.rvt"

string

params
可选

样例 : [ ]

< object > array

MEPSystem

名称 说明 类型

baseEquipment
可选

样例 : "baseEquipment"

string

id
可选

样例 : "a3c2626f51b7453682bc1ebd6bf69a28"

string

name
可选

样例 : "name"

string

network
可选

样例 : [ "NetworkNode" ]

< NetworkNode > array

systemCategory
可选

样例 : "systemCategory"

string

systemType
可选

样例 : "systemType"

string

terminals
可选

样例 : [ "string" ]

< string > array

MaterialInfo

名称 说明 类型

id
可选

样例 : "2856106"

string

name
可选

样例 : "METAL_(229,80,30)Steel"

string

parameters
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

MaterialOverrideItemVO

名称 说明 类型

colorMaterial
可选

样例 : "colorMaterial"

string

createTime
可选

样例 : 1542590241000

integer (int64)

id
可选

样例 : "1542589866041000"

string

overrideSequence
可选

样例 : 2

integer (int32)

target
可选

样例 : "-3235128584427869941"

string

targetType
可选

样例 : "3032"

string

textureMaterial
可选

样例 : "textureMaterial"

string

updateTime
可选

样例 : 1542590241000

integer (int64)

MaterialOverrideSetVO

名称 说明 类型

createTime
可选

样例 : 1542590241000

integer (int64)

id
可选

样例 : 1481411581717792

integer (int64)

name
可选

样例 : "mosV1_1542589866041"

string

overrides
可选

样例 : [ "MaterialOverrideItemVO" ]

textureMaterials
可选

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

< string, string > map

updateTime
可选

样例 : 1542590241000

integer (int64)

ModelCompareChange

名称 说明 类型

_A
可选

样例 : "string"

string

_B
可选

样例 : "string"

string

changeAttributes
可选

样例 : [ "Changed«Attribute»" ]

changeQuantities
可选

样例 : [ "Changed«Quantity»" ]

deleteAttributes
可选

样例 : [ "Attribute" ]

< Attribute > array

deleteQuantities
可选

样例 : [ "Quantity" ]

< Quantity > array

newAttributes
可选

样例 : [ "Attribute" ]

< Attribute > array

newQuantities
可选

样例 : [ "Quantity" ]

< Quantity > array

ModelCompareDiff

名称 说明 类型

categoryId
可选

样例 : "-2001320"

string

categoryName
可选

样例 : "framework"

string

diffType
可选

样例 : "CHANGE"

string

elementId
可选

样例 : "296524"

string

elementName
可选

样例 : "250 x 600 mm"

string

family
可选

样例 : "framework 1"

string

followingFileId
可选

样例 : "1136893002033344"

string

id
可选

样例 : "0213154515478"

string

previousFileId
可选

样例 : "1136239003943104"

string

specialty
可选

样例 : "civil"

string

ModelCompareFileDiff

名称 说明 类型

diffType
可选

样例 : "string"

enum (new, delete, change)

followingFileId
可选

样例 : "85fe7a969eed4c38ac1d6307ec8d4e2c"

string

previousFileId
可选

样例 : "2d7370e7c74b4a8aa5d2a684de4273cb"

string

NetworkNode

名称 说明 类型

id
可选

样例 : "004114f12a1f467e933109a2c8f04f11"

string

type
可选

样例 : "type"

string

ObjectOnFloor

名称 说明 类型

boundary
可选

样例 : ""

string

id
可选

样例 : "313137"

string

levelId
可选

样例 : "11"

string

maxPt
可选

样例 : Coordinate

minPt
可选

样例 : Coordinate

name
可选

样例 : "dining room 4"

string

Pagination«DrawingCompareDiff»

名称 说明 类型

data
可选

样例 : [ "DrawingCompareDiff" ]

< DrawingCompareDiff > array

page
可选

样例 : 2

integer (int32)

total
可选

样例 : 10

integer (int32)

Pagination«ModelCompareDiff»

名称 说明 类型

data
可选

样例 : [ "ModelCompareDiff" ]

< ModelCompareDiff > array

page
可选

样例 : 2

integer (int32)

total
可选

样例 : 10

integer (int32)

ParentAndSiblingElements

名称 说明 类型

parent
可选

siblings
可选

样例 : [ "ElementIdWithName" ]

< ElementIdWithName > array

PartialElementFile

名称 说明 类型

databagId
可选

样例 : "da5c532753ea4a6986fcd11af58b0396"

string

fileId
可选

样例 : 0

integer (int64)

PortAndView

名称 说明 类型

elevation
可选

样例 : 0.0

number (double)

outline
可选

样例 : [ 0.0 ]

< number (double) > array

viewId
可选

样例 : "6278f2c7786043d4a35ae4115571b7c8"

string

viewPoint
可选

样例 : ViewPoint

viewType
可选

样例 : "viewType"

string

viewport
可选

样例 : [ 0.0 ]

< number (double) > array

Preview

名称 说明 类型

height
可选

样例 : 0

integer (int32)

path
可选

样例 : "path"

string

width
可选

样例 : 0

integer (int32)

Property

名称 说明 类型

boundingBox
可选

样例 : BoundingBox

elementId
可选

样例 : "313052"

string

familyGuid
可选

样例 : "000222"

string

guid
可选

样例 : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc"

string

name
可选

样例 : "norm - 150mm"

string

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

IntegrateProperty

名称 说明 类型

boundingBox
可选

样例 : BoundingBox

fileIdHash
可选

样例 : "1739317053179456"

string

elementId
可选

样例 : "313052"

string

familyGuid
可选

样例 : "000222"

string

guid
可选

样例 : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc"

string

name
可选

样例 : "norm - 150mm"

string

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

PropertyFilterGroupAndKeysPair

名称 说明 类型

group
可选

样例 : "group"

string

keys
可选

样例 : [ "string" ]

< string > array

PropertyGroup

名称 说明 类型

group
可选

样例 : "dimension"

string

items
可选

样例 : [ "PropertyItem" ]

< PropertyItem > array

PropertyItem

名称 说明 类型

code
可选

样例 : "perimeter"

string

extension
可选

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

< string, string > map

key
可选

样例 : "perimeter"

string

orderNumber
可选

样例 : 0

integer (int32)

unit
可选

样例 : "mm"

string

value
可选

样例 : 17200

object

valueType
可选

样例 : 2

integer (int32)

PropertyValuesResp

名称 说明 类型

property
可选

样例 : "floor"

string

values
可选

样例 : [ "-2.45", "0.0" ]

< object > array

Quantity

名称 说明 类型

code
可选

样例 : "code"

string

desc
可选

样例 : "desc"

string

name
可选

样例 : "name"

string

qty
可选

样例 : 0

integer (int32)

unit
可选

样例 : "unit"

string

QuantityTargetTypeWithIds

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

type
可选

样例 : "string"

enum (ZSK, ROOM, ELEMENT)

RfaFamilyType

名称 说明 类型

familyTypeGuid
可选

样例 : "cfd78ac2-7b11-4a72-8ceb-04335916be57"

string

name
可选

样例 : "1200 x 2100mm"

string

RfaFamilyTypeProperty

名称 说明 类型

familyTypeId
可选

样例 : "cfd78ac2-7b11-4a72-8ceb-04335916be57"

string

name
可选

样例 : "1200 x 2100mm"

string

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

Room

名称 说明 类型

area
可选

样例 : 7.256476003661832E7

number (double)

bboxMax
可选

样例 : Coordinate

bboxMin
可选

样例 : Coordinate

boundary
可选

样例 : ""

string

id
可选

样例 : "313137"

string

levelId
可选

样例 : "11"

string

maxPt
可选

样例 : Coordinate

minPt
可选

样例 : Coordinate

name
可选

样例 : "dining room 4"

string

perimeter
可选

样例 : 40087.80000000279

number (double)

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

RoomWithElementIdFileIds

名称 说明 类型

area
可选

样例 : 7.256476003661832E7

number (double)

bboxMax
可选

样例 : Coordinate

bboxMin
可选

样例 : Coordinate

boundary
可选

样例 : ""

string

elementIdWithFileIds
可选

样例 : [ "ElementIdWithFileId" ]

id
可选

样例 : "313137"

string

levelId
可选

样例 : "11"

string

maxPt
可选

样例 : Coordinate

minPt
可选

样例 : Coordinate

name
可选

样例 : "dining room 4"

string

perimeter
可选

样例 : 40087.80000000279

number (double)

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

RoomWithElementIds

名称 说明 类型

area
可选

样例 : 7.256476003661832E7

number (double)

bboxMax
可选

样例 : Coordinate

bboxMin
可选

样例 : Coordinate

boundary
可选

样例 : ""

string

elementIds
可选

样例 : [ "11", "22" ]

< object > array

id
可选

样例 : "313137"

string

levelId
可选

样例 : "11"

string

maxPt
可选

样例 : Coordinate

minPt
可选

样例 : Coordinate

name
可选

样例 : "dining room 4"

string

perimeter
可选

样例 : 40087.80000000279

number (double)

properties
可选

样例 : [ "PropertyGroup" ]

< PropertyGroup > array

SearchAreaIdsResp

名称 说明 类型

areaIds
可选

样例 : [ "313464", "313467", "313470", "313473" ]

< object > array

targetId
可选

样例 : "3407d3d63ff04ad5af4bf4b7f3a0018a"

string

SearchElementIdsResp

名称 说明 类型

elementIds
可选

样例 : [ "313047", "313048", "313049", "313050", "313088", "313116", "313153", "313154", "313155", "313156", "313209", "313253" ]

< object > array

targetId
可选

样例 : "1373177833349216"

string

SearchRoomIdsResp

名称 说明 类型

roomIds
可选

样例 : [ "313128", "313131", "313134", "313137" ]

< object > array

targetId
可选

样例 : "e9b59687992d482ebbf880832f82413a"

string

SegmentDto

名称 说明 类型

buildingId
可选

样例 : "60e864d4d8a344e6b3903849542e0593"

string

code
可选

样例 : "code"

string

createTime
可选

样例 : 1564789874895

integer (int64)

elementIds
可选

样例 : [ "string" ]

< string > array

endElevation
可选

样例 : 0.0

number

endFloorId
可选

样例 : "1943f112344644ea9173f3f7f8391487"

string

floorIds
可选

样例 : [ "string" ]

< string > array

id
可选

样例 : "9ac228571a824f538df925835b2bf299"

string

integrateId
可选

样例 : 0

integer (int64)

isRelatedEdo
可选

样例 : true

boolean

name
可选

样例 : "name"

string

orderNo
可选

样例 : 0

integer (int32)

partialElementFileIds
可选

样例 : [ "string" ]

< string > array

partialElementFiles
可选

样例 : [ "PartialElementFile" ]

< PartialElementFile > array

remark
可选

样例 : "remark"

string

segmentGroupId
可选

样例 : "4d8f204877fb445a8008d581844640dd"

string

specialtyId
可选

样例 : "19d53c7d48c045e08a34d0337c44fb70"

string

startElevation
可选

样例 : 0.0

number

startFloorId
可选

样例 : "df4f96b261bb40e1b68af6304ca9abcd"

string

updateTime
可选

样例 : 1564789874895

integer (int64)

SegmentGroupDto

名称 说明 类型

buildingId
可选

样例 : "e991567200b64cd5a6250b3431de553f"

string

code
可选

样例 : "code"

string

createTime
可选

样例 : 1564789874888

integer (int64)

floorId
可选

样例 : "6674f72cbc3749f58793364cc2350c87"

string

id
可选

样例 : "be21887bb9cd4157a4da1e923af35d95"

string

integrateId
可选

样例 : 0

integer (int64)

name
可选

样例 : "name"

string

orderNo
可选

样例 : 0

integer (int32)

parentId
可选

样例 : "960f9e4e1a83424481ec3f83d339dd7e"

string

remark
可选

样例 : "remark"

string

segments
可选

样例 : [ "SegmentDto" ]

< SegmentDto > array

specialtyId
可选

样例 : "366f0436348d45098fa944af28ad52f3"

string

subGroups
可选

样例 : [ "SegmentGroupDto" ]

< SegmentGroupDto > array

type
可选

样例 : 0

integer (int32)

updateTime
可选

样例 : 1564789874888

integer (int64)

SingleModelElementsSwaggerDisplay

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : ""

string

message
可选

样例 : "string"

string

SpecialtyNode

名称 说明 类型

categories
可选

样例 : [ "CategoryNode" ]

< CategoryNode > array

itemCount
可选

样例 : 0

integer (int32)

specialtyId
可选

样例 : "809d9ef628ec4ee8a3e86152c246dab4"

string

specialtyName
可选

样例 : "specialtyName"

string

Tree

名称 说明 类型

items
可选

样例 : [ "TreeNode" ]

< TreeNode > array

root
可选

样例 : "specialty"

string

TreeNode

名称 说明 类型

actualName
可选

样例 : "actualName"

string

data
可选

样例 : "object"

object

elementCount
可选

样例 : 0

integer (int32)

id
可选

样例 : "24507acf86734fcdafcfcc5b70497cd5"

string

items
可选

样例 : [ "TreeNode" ]

< TreeNode > array

name
可选

样例 : "name"

string

type
可选

样例 : "type"

string

TreeNodeSort

名称 说明 类型

nodeType
可选

样例 : "3"

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

sortBy
可选

样例 : "SORT_BY_NAME"

string

sortedValues
可选

样例 : [ "string" ]

< string > array

View

名称 说明 类型

cropBox
可选

样例 : [ -12147.804809235151, -19279.554054815613, -30480.0, 22637.545576143948, 6805.089759789783, 30480.0 ]

< object > array

elevation
可选

样例 : 0.0

number (double)

id
可选

样例 : "312"

string

levelId
可选

样例 : "312"

string

name
可选

样例 : "Level 1"

string

outline
可选

样例 : [ -146.52900292249365, -215.01048476685295, 240.3331231070219, 110.78415780710446 ]

< object > array

preview
可选

样例 : Preview

thumbnails
可选

样例 : [ "m.bimface.com/9b711803a43b92d871cde346b63e5019/resource/thumbnails/312/312.96x96.png" ]

< object > array

viewPoint
可选

样例 : ViewPoint

viewType
可选

样例 : "FloorPlain"

string

ViewPoint

名称 说明 类型

origin
可选

样例 : [ 0.0 ]

< number (double) > array

rightDirection
可选

样例 : [ 0.0 ]

< number (double) > array

scale
可选

样例 : 0

integer (int32)

upDirection
可选

样例 : [ 0.0 ]

< number (double) > array

viewDirection
可选

样例 : [ 0.0 ]

< number (double) > array