BIMFACE服务器端API接口

模型集成

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

目前在实际项目中，不同专业的团队成员可能会采用不同软件进行建模，然后再将不同格式的模型导入如Navisworks等软件中，但这样的方法有如下的缺点：

  • 即使仅为了满足浏览模型的需求，也需要安装用来集成不同格式模型的桌面端软件；

  • 桌面端软件支持的模型文件格式有限，无法满足多种文件格式的模型集成需求；

  • 在诸如Navisworks等软件中进行的模型导入只做了几何的导入集成，不支持上面提到的建筑领域各种分类信息；

  • 只支持桌面端浏览模型，同时软件也对操作系统有明确要求，普遍无法支持移动端的iOS和安卓操作系统；

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

在业务方面，BIMFACE的模型集成能：

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

  • 自定义楼层映射

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

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

  • 支持自定义文件转换矩阵（transform）

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

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

    • 识别基本体

    • 实例绘制优化

    • 同材质全场景动态合并

    • 外围壳光线追踪识别

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

当单个模型文件转换成功以后，可以将多个单文件集成，生成一个全专业/楼层模型。由于集成不能立即完成，BIMFACE支持在模型集成完成以后，通过Callback机制通知调用方（请参考这里）；另外，调用方也可以通过接口查询集成状态。目前BIMFACE支持集成的模型文件格式包括：rvt、dgn、ifc、nwd、skp、3dm、3ds、fbx、stp。

模型集成发起相关

发起模型集成

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Body

request
必填

模型集成请求体
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrate
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "callback" : "https://api.glodon.com/viewing/callback?authCode=6kj0Jk0affae&signature=2ef131395fb6442eb99abd83d45c6016",
  "config" : {},
  "name" : "integrate",
  "sourceId" : "hduf2w3ho21nowr23rqwjrn2o3",
  "sources" : [ {
    "fileId" : 1656504297006400
  },
   {
    "fileId" : 1552501367034816
  }]
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-12-25 17:25:25",
    "integrateId" : 1248789977538784,
    "name" : "integrate-x",
    "reason" : "reason",
    "sourceId" : "123156522123",
    "status" : "success",
    "thumbnail" : [ "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/96.png", "https://m.bimface.com/dc6aa5e35b6a269972b005b4b2aac8ce/thumbnail/256.png" ]
  },
  "message" : ""
}

另外几种发起模型集成的请求体示例:
1. 带链接关系的rvt模型集成（需要指定integrate-with-links）

{
    "sources": [
        {
            "fileId": 9220020202001
        },
        {
            "fileId": 9220020202002
        }
    ],
    "sourceId":"123456",
    "name":"我的合并模型",
    "callback": "http://www.app.com/receive",
    "config":{
        "integrate-with-links": true
    }
}

2. 设置集成模型支持按需加载（需要指定loadOnDemand和fileType，fileType目前支持rvt和igms两种格式）

{
    "sources": [
      {
          "fileId":1552501392454592
      },
       {
          "fileId":1552501367034816
      }
    ],
    "config":{"loadOnDemand":true,"fileType": "igms"},
    "name": "按需加载_同1552361627558592",
}

3. 设置集成模型中单文件的楼层名称、楼层排序、楼层标高（需要指定floor，floorSort，elevation，不适用链接集成的情况）

{
    "sources": [
        {
            "fileId": 1552501392454592,
            "floor":"F01",
            "floorSort":0.5,
            "elevation":4500
        },
        {
            "fileId": 1552501367034816,
            "floor":"F01",
            "floorSort":0.5,
            "elevation":9000
        }
    ],
    "sourceId":"123456",
    "name":"我的合并模型",
    "callback": "http://www.app.com/receive",
    "config":{
    }
}

4. 自定义集成模型的构件树（可以在config中组织模型文件的层级关系）

{
	"sources": [
		{
			"fileId": 1552501392454592
		},
		{
			"fileId": 1552501367034816
		}
	],
	"sourceId": "123456",
	"name": "我的合并模型",
	"callback": "http://www.app.com/receive",
	"config": {
		"customizedTree": [
			{
				"name": "一期工程",
				"type": "group",
				"items": [
					{
						"name": "建筑",
						"type": "group",
						"items": [
							{
								"name": "建筑模型.rvt",
								"type": "model",
								"fileId": "1552501392454592"
							}
						]
					},
					{
						"name": "场地",
						"type": "group",
						"items": [
							{
								"name": "场地模型.rvt",
								"type": "model",
								"fileId": "1552501367034816"
							}
						]
					}
				]
			}
		]
	}
}
请求体参数说明
字段 类型 必填 描述 示例

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

source.elevation

Number

N

指定集成文件中单文件的标高值，与楼层名称对应，数值默认单位mm

4500

sourceId

String

N

调用方自定义的源ID

857482189666208

name

String

N

调用方设置的名称

我的合并模型

callback

String

N

Callback地址，待集成完毕以后，BIMFACE会回调该地址(请参考这里)

http://www.app.com/receive

config

Json Object

N

发起模型集成支持的配置。例如发起带链接关系的rvt模型集成，则添加参数值{"integrate-with-links": true}；发起按需加载的模型集成，则需要指定loadOnDemand和fileType，fileType目前支持rvt和igms两种格式，可添加参数值{"loadOnDemand":true,"fileType": "igms"}。

{"integrate-with-links": true}等

模型集成支持的自定义参数config：

字段

描述

取值

默认值

floorRemap

是否按标高进行楼层的重新分配

true,false

true

positioning

按模型共享坐标集成

sharedCoordinates

空

integrate-with-links

是否使用链接集成方法

true,false

false

loadOnDemand

是否采用按需加载，需指定文件格式

true,false

false

fileType

String

空

customizedTree

自定义构件树

Array

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

integrateId

Number

集成Id

85929027838566

name

String

调用方设置的名称

我的合并模型

status

String

集成状态

processing（集成中）、success（集成成功）、failed（集成失败）

thumbnail

String[]

缩略图地址

…

reason

String

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

…

createTime

String

集成开始时间，格式：yyyy-MM-dd hh:mm:ss

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

system.error

BIMFACE系统异常

authentication.failed

API访问合法性校验失败

input.parameter.error

输入的参数有误

url.invalid

回调地址不是正确的URL

file.not.found

文件不存在

file.type.not.support

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

file.has.not.translated

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

file.is.translating

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

file.translate.failed

文件转换失败，不能集成

查询集成状态

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

integrateId
必填

集成模型id

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

批量查询集成模型状态详情

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

调用方发起集成以后，可以根据筛选条件，通过该接口批量查询集成模型状态详情

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Body

integrateQueryRequest
必填

集成模型查询请求体
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/integrateDetails
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "appKey" : "appKey",
  "endDate" : "string",
  "fileName" : "fileName",
  "integrateId" : 0,
  "integrateType" : "integrateType",
  "pageNo" : 0,
  "pageSize" : 0,
  "sortType" : "sortType",
  "sourceId" : "cdcd16c9e63f445eb48ccc983dde3d35",
  "startDate" : "string",
  "status" : 0
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "list" : [ {
      "cost" : 0,
      "createTime" : "createTime",
      "databagId" : "8307d4628e6b4ffaa45747b0ae3a25e5",
      "integrateId" : 0,
      "name" : "name",
      "offlineDatabagStatus" : "offlineDatabagStatus",
      "reason" : "reason",
      "shareToken" : "shareToken",
      "shareUrl" : "shareUrl",
      "sourceId" : "4de13d5dc8a948f1b661999a44584654",
      "status" : "status",
      "thumbnail" : [ "string" ],
      "type" : "type",
      "workerType" : "workerType"
    } ],
    "page" : {
      "htmlDisplay" : "string",
      "nextPage" : 0,
      "pageNo" : 0,
      "pageSize" : 0,
      "prePage" : 0,
      "startIndex" : 0,
      "totalCount" : 0,
      "totalPages" : 0
    }
  },
  "message" : ""
}
请求体参数说明
字段 类型 必填 描述 示例

appKey

String

否

应用的appKey

iYapD4hT9yCPKkkl7lb7bh9Wr2icezUQ

integrateId

String

否

集成模型的id

1216871503527744

integrateType

String

否

集成模型的类型

rvt(或者igms…​)

fileName

String

否

集成模型的名称

integrate-test

sourceId

String

否

模型对应的sourceId

389c28de59ee62e66a7d87ec12692a76

pageNo

Int

否

页码

2

pageSize

Int

否

每页返回数目

20

status

Byte

否

模型状态码

1(处理中); 99(成功); -1(失败)

sortType

String

否

筛选类型

create_time desc

startDate

String

否

开始日期

2019-05-01

endDate

String

否

截止日期

2019-05-01
返回体参数说明
字段 类型 描述 示例

cost

Int

任务耗时

64（单位：秒）

createTime

String

创建时间

2019-05-19 20:40:34

databagId

String

数据包id

70b8c10b686061525420fc240bf48aca

integrateId

Int

集成模型的id

1609858191716512

name

String

集成模型的名称

integrate-test

offlineDatabagStatus

String

离线数据包生成状态

prepare(未生成); processing(生成中); success(生成成功); failed(生成失败)

reason

String

若转换失败，返回失败原因

该字段暂时空置

shareToken

String

分享码

3c476c55

shareUrl

String

分享链接

https://api.bimface.com/preview/3c476c55

sourceId

String

模型对应的sourceId

该字段暂时空置

status

String

模型状态

processing(处理中); success(成功); failed(失败)

thumbnail

String

模型的缩略图

该字段暂时空置

type

String

集成类型

rvt(或者igms…​)

workerType

String

处理集成任务的worker类型

rvt

nextPage

Int

下一页码

2

pageNo

Int

当前页码

1

pageSize

Int

每页条目数

20

prePage

Int

上一页码

1

startIndex

Int

起始索引数

0

totalCount

Int

条目总数

47

totalPages

Int

页码总数

3

删除集成模型

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

integrateId
必填

集成模型id

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

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容
生成

  • */*

  • application/json

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

集成模型数据

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

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

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

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

categoryId
可选

筛选条件构件类型id

string

Query

family
可选

筛选条件族

string

Query

familyType
可选

筛选条件族类型

string

Query

floor
可选

筛选条件楼层

string

Query

paginationContextId
可选

根据paginationContextId返回构件ID列表

string

Query

paginationNo
可选

返回结果中paginationNo对应的页码构件ID项

integer (int32)

Query

paginationSize
可选

返回结果按照paginationSize分页

integer (int32)

Query

roomId
可选

筛选条件房间id

string

Query

roomToleranceXY
可选

XY坐标轴方向对构件的筛选容忍度

enum (STRICT, ORDINARY, LENIENT)

Query

roomToleranceZ
可选

Z坐标轴方向对构件的筛选容忍度

enum (STRICT, ORDINARY, LENIENT)

Query

specialty
可选

筛选条件专业

string

Query

systemType
可选

筛选条件系统类型

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取指定构件的材质信息

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

Header

Authorization
必填

bearer {accessToken}

string

Path

elementId
必填

构件ID

string

Path

fileIdHash
必填

子文件ID

string

Path

integrateId
必填

集成ID

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

模型集成ID

integer (int64)

Body

fileIdWithEleIdList
可选

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

< string > array
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取指定构件的属性

GET https://api.bimface.com/data/v2/integrations/{integrateId}/elements/{elementId}
说明
支持查询模型属性重写后构件的属性，需要设置请求参数includeOverrides的值为true
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

elementId
必填

构件ID

string

Path

integrateId
必填

集成ID

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/elements/313052

若需查询重写后的构件属性，请求示例为
https://api.bimface.com/data/v2/integrations/1211286711525184/elements/313052?includeOverrides=true
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "dimension",
      "items" : [ {
        "code" : "perimeter",
        "extension" : "object",
        "key" : "perimeter",
        "orderNumber" : 0,
        "unit" : "mm",
        "value" : 17200,
        "valueType" : 2
      } ]
    } ]
  },
  "message" : ""
}

获取多个构件的公共属性

POST https://api.bimface.com/data/v2/integrations/{integrateId}/commonElementProperties
说明
若传入的elementId不止一个，则返回这些elementId共同的属性，共同的定义为：属性key与value都相等
支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeOverrides
可选

是否查询修改的属性

boolean

Body

fileIdHashWithElementIdsList
可选

fileIdHashWithElementIdsList
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/commonElementProperties

若需查询重写后的构件的共同属性，请求示例为
https://api.bimface.com/data/v2/integrations/1211286711525184/commonElementProperties?includeOverrides=true
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
[ {
  "fileIdHash" : "1365346274583424",
  "elementIds" : [ "1109329", "1109300" ]
} ]
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" : "dimension",
      "items" : [ {
        "code" : "perimeter",
        "extension" : "object",
        "key" : "perimeter",
        "orderNumber" : 0,
        "unit" : "mm",
        "value" : 17200,
        "valueType" : 2
      } ]
    } ]
  },
  "message" : ""
}

批量获取构件属性

POST https://api.bimface.com/data/v2/integrations/{integrateId}/elements
说明
支持批量查询集成模型指定子文件的构件属性
支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeOverrides
可选

是否查询修改的属性

boolean

Body

filterRequest
必填

filterRequest
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1211286711525184/elements

若需查询重写后的构件属性，请求示例为
https://api.bimface.com/data/v2/integrations/1211286711525184/elements?includeOverrides=true
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "filter" : [{
    "group": "dimension"
  },
  {
    "group" : "size",
    "keys" : [ "length", "width" ]
  } ],
  "ids" : [ {
    "fileIdHash" : "1739317053179456",
    "elementIds" : [ "313154", "313047" ]
  } ]
}
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
      }
    },
    "fileIdHash": "1739317053179456",
    "elementId" : "313154",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "dimension",
      "items" : [ {
        "code" : "perimeter",
        "extension" : "object",
        "key" : "perimeter",
        "orderNumber" : 0,
        "unit" : "mm",
        "value" : 17200,
        "valueType" : 2
      } ]
    } ]
  } ],
  "message" : ""
}

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

GET https://api.bimface.com/data/v2/integrations/{integrateId}/files/{fileIdHash}/elements/{elementId}
说明
支持查询模型属性重写后构件的属性，需要设置请求参数includeOverrides的值为true
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

elementId
必填

构件ID

string

Path

fileIdHash
必填

文件ID

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeOverrides
可选

是否查询修改的属性

boolean
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/integrations/1432597241469056/files/8bf8b9c295382c30c9803fc4ca21278e/elements/313052

若需查询重写后的构件属性，请求示例为
https://api.bimface.com/data/v2/integrations/1432597241469056/files/8bf8b9c295382c30c9803fc4ca21278e/elements/313052?includeOverrides=true
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "boundingBox" : {
      "max" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "min" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      }
    },
    "elementId" : "313052",
    "familyGuid" : "000222",
    "guid" : "79d547c1-5dbf-4e6a-811d-951cf37b29da-0004c6dc",
    "name" : "norm - 150mm",
    "properties" : [ {
      "group" : "dimension",
      "items" : [ {
        "code" : "perimeter",
        "extension" : "object",
        "key" : "perimeter",
        "orderNumber" : 0,
        "unit" : "mm",
        "value" : 17200,
        "valueType" : 2
      } ]
    } ]
  },
  "message" : ""
}

获取楼层列表

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeArea
可选

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

boolean

Query

includeRoom
可选

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

boolean
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

includeDrawingSheet
可选

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

boolean
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取集成文件链接关系

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

获取集成模型中单模型之间的链接关系，该方法仅对链接集成模型生效。

参数
类型 名称 说明 类型

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/data/v2/integrations/1365349517067680/linkGraph
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
	"code": "success",
	"data": [
		{
			"databagId": "67ea053b899d9d7d15c265d19e367aa5",
			"fileId": "1739317053179456",
			"linkName": "",
			"linkPathHash": "1739317053179456",
			"linkTransform": "",
			"links": [
				{
					"databagId": "18f5817065566fde38781b0cc04303bf",
					"fileId": "1739317400086080",
					"linkName": "建筑.rvt : 端户01 : 位置 <未共享>",
					"linkPathHash": "4a9a86ef19c948ba847b3647246bd141",
					"linkTransform": "[-1,0,0,0,0,1,0,0,0,0,1,0,1.307088E-09,0,0,1]",
					"links": [
						{
							"databagId": "b46ea4d9428c1cde059ae4aaa8692e53",
							"fileId": "1739317527045696",
							"linkName": "暖通.rvt : 4 : 位置 <未共享>",
							"linkPathHash": "b3a2780e9d419615e65618a84d26bf95",
							"linkTransform": "",
							"links": [],
							"name": "暖通.rvt",
							"params": []
						}
					],
					"name": "建筑.rvt",
					"params": []
				}
			],
			"name": "场地.rvt",
			"params": []
		}
	],
	"message": null
}

获取指定房间的属性

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Path

roomId
必填

房间ID

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

floorId
必填

楼层ID

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取指定面积分区的属性

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

Header

Authorization
必填

bearer {accessToken}

string

Path

areaId
必填

面积分区ID

string

Path

integrateId
必填

集成ID

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取分类树

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

desiredHierarchy
可选

分类树的层次结构

< string > array(multi)

Query

treeType
可选

分类树类型

string

"floor"

Body

requestBody
可选

指定排序，显示的构件列表等可选项
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

请求楼层分类树（floor, specialty, category, family, familyType）

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

请求专业分类树（specialty, floor, category, family, familyType）

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

请求自定义分类树

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

请求自定义分类树（带自定义排序）

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

获取视图信息

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

viewType
可选

视图类型

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

数据实体类

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