BIMFACE服务器端API接口

构件空间关系计算

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

房间与构件空间关系计算相关的接口

  • https://api.bimface.com/data/v2/files/{fileId}/elementIds?roomId=&roomToleranceZ=&roomToleranceXY=

  • https://api.bimface.com/data/v2/files/{fileId}/rooms?elementId=&roomToleranceZ=&roomToleranceXY=

  • https://api.bimface.com/data/v2/integrations/{integrateId}/elementIds?roomId=&roomToleranceZ=&roomToleranceXY=

  • https://api.bimface.com/data/v2/integrations/{integrateId}/rooms?elementId=&roomToleranceZ=&roomToleranceXY=

参数 roomToleranceZ 说明

默认值:STRICT

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

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

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

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

roomToleranceZ

参数 roomToleranceXY 说明

默认值:ORDINARY

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

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

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

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

roomToleranceXY

获取楼层对应房间列表

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

文件ID

integer (int64)

Query

elementId
可选

构件ID

string

Query

floorId
可选

楼层ID

string

Query

roomToleranceXY
可选

XY方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"ORDINARY"

Query

roomToleranceZ
可选

Z方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"STRICT"

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

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

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

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

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

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

Header

Authorization
必填

bearer {accessToken}

string

Path

integrateId
必填

集成ID

integer (int64)

Query

elementId
可选

构件ID

string

Query

fileIdHash
可选

子文件ID

string

Query

floorId
可选

楼层ID

string

Query

roomToleranceXY
可选

XY方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"ORDINARY"

Query

roomToleranceZ
可选

Z方向的误差容许程度

enum (STRICT, ORDINARY, LENIENT)

"STRICT"

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

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

数据实体类

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)

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«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«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

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

名称 说明 类型

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

PropertyGroup

名称 说明 类型

group
可选

样例 : "dimension"

string

items
可选

样例 : [ "PropertyItem" ]

< PropertyItem > array

PropertyItem

名称 说明 类型

code
可选

样例 : "perimeter"

string

extension
可选

样例 : "object"

object

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