BIMFACE服务器端API接口

文件转换

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

  1. 发起模型转换

  2. 查询转换状态

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

模型上传成功后，即可发起模型转换。 由于模型转换不能立即完成，BIMFACE支持在模型转换完成以后，通过Callback机制通知调用方(请参考这里)；另外，调用方也可以通过接口查询转换状态。
在模型成功进行转换后，模型内的BIM信息会在云端进行解析，抽取并结构化入库。这些信息包含：

  • 构件属性信息

  • 构件分类树

  • 楼层

  • 单体

  • 专业

  • 构件材质

  • 模型链接

  • 空间

  • 房间

  • 图纸

  • …​

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

Access Token

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

View Token

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

发起源文件/模型转换

发起转换

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Body

request
必填

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

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/translate
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求 body
{
  "callback" : "https://api.glodon.com/viewing/callback?authCode=iklJk0affae&signature=2ef131395fb6442eb99abd83d45c3201",
  "config" : {
    "string" : "string"
  },
  "source" : {
    "compressed" : false,
    "fileId" : 1277823232112,
    "rootName" : "rootFileName.rvt"
  }
}
注意：请求体中的config可以设置为空
"config":null
或者传入指定的转换参数
"config":{
  "texture":true
}
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-12-25 17:23:46",
    "databagId" : "9b711803a43b92d871cde346b63e5019",
    "fileId" : 1248789071339712,
    "name" : "bimface_2018.rvt",
    "reason" : "reason",
    "status" : "success",
    "thumbnail" : [ "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/96.png", "https://m.bimface.com/9b711803a43b92d871cde346b63e5019/thumbnail/256.png" ]
  },
  "message" : ""
}

另外几种发起转换的请求体示例:
1. DWG文件转换
（1）DWG文件转换成矢量图纸

{
    "source":{
        "fileId":1402934652281952,
        "compressed":false
    },
    "callback":"http://www.app.com/receive",
    "config":null
}

（2）DWG文件转换成图片

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

（3）DWG文件解析轴网信息

{
	"source": {
		"fileId": 857482189666208,
		"compressed": false,
		"rootName": "root.dwg"
	},
	"callback": "http://www.app.com/receive",
	"config": {
		"exportAxisGrids": {
			"gridLines": [
				"A1-WC$0$DOTE",
				"A2-WC$0$DOTE"
			],
			"gridBubbles": [
				"A1-WC$0$AXIS_TEXT",
				"A2-WC$0$AXIS_TEXT"
			]
		}
	}
}

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

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

（2）RVT文件转换成真实模式的效果

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

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

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

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

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

请求体内的参数解释：

字段

类型

必填

描述

示例

fileId

Number

Y

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

857482189666208

compressed

Boolean

N

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

true, false

rootName

String

N

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

root.rvt

callback

String

N

Callback地址，待转换完毕以后，BIMFace会回调该地址 请参考这里

http://www.app.com/receive

config

Json Object

N

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

{"texture":true}等

不同模型转换支持的自定义参数config：
(1) rvt模型

字段

描述

取值

默认值

texture

转换时是否添加材质

true,false

false

viewName

转换使用的3D视图

string

{3D}

displaylevel

设置转换的精细度

fine（精细），medium（中等），coarse（粗略）

fine

exportHiddenObjects

是否导出三维视图中隐藏的构件

true,false

false

exportSchedule

是否使用明细表内容

true,false

false

exportViewImage

是否导出视图图片

true,false

false

viewImageDPI

设置导出视图图片精度

72,150,300

150

export3DViews

导出三维视图列表

array("all"代表所有视图)

[]

drawingGroups

导出指定分组中的图纸

array(多个层级用"\\"划分，如：{"drawingGroups": ["03.PUBLISHED\\DETAILS", "02.SHARED"]})

[]

language

语言版本

zh_CN（中文版），en_GB（英文版）

zh_CN

customizedObjectData

指定构件属性作为objectData，并根据objectData组织构件树。指定的构件属性作为构件树的各级节点，层级顺序与输入的属性顺序一致，前面的字段作为后面字段的父节点。

Array

空

(2) dwg模型

字段

描述

取值

默认值

exportDrawing

是否转成矢量图纸

true,false

true

exportPdf

是否导出pdf文件

true,false

false

exportThumb

是否导出缩略图

true,false

true

exportAxisGrids

解析轴网信息

{ "gridLines":["轴线所在图层"], "gridBubbles":["轴号所在图层"] }

空

viewType

dwg文件的显示类型

2D,3D

空

(3) 其他格式

字段

支持格式

描述

取值

默认值

objectMap

ifc

导出指定属性与构件ID的映射关系

Array（如：{"objectMap": ["tag"]}）

[]

获取转换状态

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

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

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

fileId
必填

文件id

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

批量获取转换状态详情

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

应用发起转换以后，可以根据筛选条件，通过该接口批量查询转换状态详情

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Body

translateQueryRequest
必填

转换模型查询请求体
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

appKey

String

否

应用的appKey

iYapD4hT9yCPKkkl7lb7bh9Wr2icezUQ

fileId

String

否

单模型对应的id

1216871503527744

suffix

String

否

单模型的文件类型

rvt(或者igms,dwg…​)

fileName

String

否

单模型的名称

translate-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
返回体参数说明
字段 类型 描述 示例

appKey

String

应用的appkey

iYapD4hT9yCPKkkl7lb7bh9Wr2icezUQ

cost

Int

任务耗时

64（单位：秒）

createTime

String

创建时间

2019-05-19 20:40:34

databagId

String

数据包id

70b8c10b686061525420fc240bf48aca

fileId

Int

模型的fileId

1609858191716512

length

Int

文件长度

5292032（单位：字节）

name

String

集成模型的名称

integrate-test

offlineDatabagStatus

String

离线数据包生成状态

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

reason

String

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

该字段暂时空置

retry

Boolean

重试

true(或者false)

shareToken

String

分享码

3c476c55

shareUrl

String

分享链接

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

sourceId

String

模型对应的sourceId

该字段暂时空置

status

String

模型状态

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

supportOfflineDatabag

Boolean

是否支持离线数据包

true(或者false)

thumbnail

String

模型的缩略图

该字段暂时空置

type

String

转换类型

rvt-translate(或者igms-translate…​)

nextPage

Int

下一页码

2

pageNo

Int

当前页码

1

pageSize

Int

每页条目数

20

prePage

Int

上一页码

1

startIndex

Int

起始索引数

0

totalCount

Int

条目总数

47

totalPages

Int

页码总数

3

获取图纸数据

发起图纸拆分

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

通过图纸文件ID，按图框拆分图纸。

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

图纸文件ID

integer (int64)

Query

callback
可选

回调url

string
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

获取图纸拆分状态

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

图纸发起拆分后，可以通过该接口查询拆图状态

参数
类型 名称 说明 类型

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/split
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2018-03-29 18:26:01",
    "fileId": 1902753151453280,
    "databagVersion" : "3.1",
    "length" : 0,
    "reason" : "reason",
    "status" : "success"
  },
  "message" : ""
}

获取图纸拆分结果

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

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/data/v2/files/1211223382064960/frames
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
    "code": "success",
    "data": [
        {
            "frames": [
                {
                    "boundingBox": {
                        "max": {
                            "x": -4938.068482562385,
                            "y": -3201.59397858169
                        },
                        "min": {
                            "x": -4938.068482562385,
                            "y": -3201.59397858169
                        }
                    },
                    "id": 1,
                    "name": "一层平面图",
                    "number": "M1221"
                }
            ],
            "id": 0,
            "name": "model"
        },
        {
            "frames": [
                {
                    "boundingBox": {
                        "max": {
                            "x": -4938.068482562385,
                            "y": -3201.59397858169
                        },
                        "min": {
                            "x": -4938.068482562385,
                            "y": -3201.59397858169
                        }
                    },
                    "id": 2,
                    "name": "二层平面图",
                    "number": "M1222"
                }
            ],
            "id": 3502692,
            "name": "layout1"
        },
        {
            "frames": [
                {
                    "boundingBox": {
                        "max": {
                            "x": -4938.068482562385,
                            "y": -3201.59397858169
                        },
                        "min": {
                            "x": -4938.068482562385,
                            "y": -3201.59397858169
                        }
                    },
                    "id": 3,
                    "name": "三层平面图",
                    "number": "M1223"
                }
            ],
            "id": 3502692,
            "name": "layout2"
        }
    ],
    "message": ""
}

获取模型数据

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

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

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

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件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/files/1211223382064960/elementIds
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
    "code": "success",
    "message": null,
    "data": [
        "1107237",
        "1109326",
        "1107234",
        "1109327",
        "1107235",
        "1107239",
        "1109329",
        "1107236",
        "1109325",
        "1107238",
        "1109328"
    ]
}

获取构件材质列表

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

Header

Authorization
必填

bearer {accessToken}

string

Path

elementId
必填

代表该单模型的构件ID

string

Path

fileId
必填

代表该单模型的文件ID

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

获取构件属性

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

Header

Authorization
必填

bearer {accessToken}

string

Path

elementId
必填

代表该单模型的构件ID

string

Path

fileId
必填

代表该单模型的文件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/files/1211223382064960/elements/1109329

若需查询重写后的构件属性，请求示例为
https://api.bimface.com/data/v2/files/1211223382064960/elements/1109329?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/files/{fileId}/commonElementProperties
说明
若传入的elementId不止一个，则返回这些elementId共同的属性，共同的定义为：属性key与value都相等
支持查询模型属性重写后多个构件的共同属性，需要设置请求参数includeOverrides的值为true
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Query

elementIds
必填

代表该单模型的构件ID列表

< string > array(multi)

Query

includeOverrides
可选

是否查询修改的属性

boolean
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/commonElementProperties?elementIds=string

若需查询重写后的构件的共同属性，请求示例为
https://api.bimface.com/data/v2/files/1211223382064960/commonElementProperties?elementIds=string&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/files/{fileId}/elements
说明
支持查询模型属性重写后多个构件的属性，需要设置请求参数includeOverrides的值为true
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件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/files/1211223382064960/elements

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

获取单模型的楼层信息

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件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/files/1211223382064960/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/files/{fileIds}/fileIdfloorsMappings
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

fileIds
必填

多个模型的文件ID

< string > array(multi)

Query

includeArea
可选

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

boolean

Query

includeRoom
可选

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

boolean
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960,1211223382064961/fileIdfloorsMappings
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
    "code": "success",
    "message": null,
    "data": [
        {
            "fileId": "1211223382064960",
            "floors": [
                {
                    "archElev": 0,
                    "areas": null,
                    "elevation": 0,
                    "height": null,
                    "id": "311",
                    "miniMap": "m.bimface.com/b5dee8260e202863066714ace1633ad9/resource/model/maps/1F.png",
                    "name": "1F",
                    "rooms": null,
                    "structElev": 0
                },
                {
                    "archElev": 4200,
                    "areas": null,
                    "elevation": 4200,
                    "height": null,
                    "id": "694",
                    "miniMap": "m.bimface.com/b5dee8260e202863066714ace1633ad9/resource/model/maps/2F.png",
                    "name": "2F",
                    "rooms": null,
                    "structElev": 4200
                },
                {
                    "archElev": -9900,
                    "areas": null,
                    "elevation": -9900,
                    "height": null,
                    "id": "268400",
                    "miniMap": null,
                    "name": "-2F",
                    "rooms": null,
                    "structElev": -9900
                }
            ]
        },
        {
            "fileId": "1570831055575328",
            "floors": [
                {
                    "archElev": 0,
                    "areas": null,
                    "elevation": 0,
                    "height": null,
                    "id": "13071",
                    "miniMap": null,
                    "name": "F1",
                    "rooms": null,
                    "structElev": 0
                },
                {
                    "archElev": 3500,
                    "areas": null,
                    "elevation": 3500,
                    "height": null,
                    "id": "15913",
                    "miniMap": null,
                    "name": "F2",
                    "rooms": null,
                    "structElev": 3500
                }
            ]
        }
    ]
}

获取模型链接信息

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

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

获取单个房间信息

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Path

roomId
必填

房间ID

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件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/files/1211223382064960/areas?floorId=311
请求 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/files/{fileId}/areas/{areaId}
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

areaId
必填

面积分区ID

string

Path

fileId
必填

代表该单模型的文件ID

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

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/areas/313467
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "area" : 5.168684733047761E7,
    "boundary" : "",
    "id" : "313137",
    "levelId" : "11",
    "maxPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "minPt" : {
      "x" : -4938.068482562385,
      "y" : -3201.59397858169,
      "z" : 0.0
    },
    "name" : "dining room 4",
    "perimeter" : 28802.013920728663,
    "properties" : [ {
      "group" : "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/files/{fileId}/tree
说明

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Query

treeType
可选

分类树的类型

string

"default"

Query

v
可选

格式

string

Body

fileTreeRequest
可选

fileTreeRequest
响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/json

生成

  • */*

  • application/json

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

请求2.0的默认分类树（floor, category, family, familyType）

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

请求自定义树（floor, category, family, familyType）

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

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

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

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

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

Header

Authorization
必填

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

获取MEP系统信息

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

需要获取系统信息的文件Id

integer (int64)

Query

systemCategory
可选

希望获取的系统的systemCategory

string

Query

systemType
可选

希望获取的系统的systemType

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

HTTP请求示例
请求 path
https://api.bimface.com/data/v2/files/1211223382064960/MEPSystem
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "baseEquipment" : "513637",
    "id" : "527027",
    "name" : "Hydronic Supply",
    "network" : [ {
      "id" : "813623",
      "type" : "管件"
    } ],
    "systemCategory" : "管道系统",
    "systemType" : "DomesticHotWater",
    "terminals" : ["386031"]
  } ],
  "message" : ""
}

获取图纸列表

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

如果请求参数elementId为null，返回所有图纸，否则返回包含该构件的所有图纸

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

代表该单模型的文件ID

integer (int64)

Query

elementId
可选

构件ID

string
响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • */*

  • application/json

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

数据实体类

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