Versions Compared

Old Version 2

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version Current

changes.mady.by.user Fritz Sandner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ElementType Service

...

ElementType Service

...

Element type describes the type of predefined building elements required to build a building (eg: wall, window, door etc) Each element type have an unique id. Please see the detailed structure of the ElementType in the Object Model

The available element types can be found under 2.1.4.1 Bimplus Element Types

Anchor
getElementTypes
getElementTypes

Get the element types
Deck of Cards
idbimGetElementTypes
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: element-types 

URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types

Example: https://api-stage.bimplus.net/v2/bimplus/element-types

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the list of existing element types.
Card
labelRequest
Code Block
lang
borderColorGreen
langxml
titleHeadersxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
langxml
[3]
0:  [3]
0:{
    {
"type": "GeometryObjectColumn",
    "category": "/1/3010/42/",
    "name": "3D object"
ifcTypeID_ArchColumn",
    "ifcType": "ID_IFCBuildingElementProxyIFCColumn",
    "id": "5a8a86702e308afe-cb9fd078-4f044c20-a467b53c-04a9e416a6d076b2da66d848"
  }-,
1:  {
    "type": "ChimneyDoorOpening",
    "category": "/5/1/10/8/",
    "name": "ChimneyID_ArchDoorOpening",
    "ifcType": "ID_IFCBuildingElementProxyIFCOpeningElement",
    "id": "e504f24c9eaf09c4-e6431f56-452b43ee-b901b008-6a18883dc7e95291ec50e7e1"
  }-,
2:  {
    "type": "ColumnFoundation",
    "category": "/1/10/26/",
    "name": "ColumnID_ArchFoundation",
    "ifcType": "ID_IFCColumnIFCFooting",
    "id": "2e308afe3a508cf2-d078bb2f-4c204cc5-b53c9b8c-76b2da66d848fbc1a5848bba"
  },
  ...
]

Anchor
getElementTypeProp
getElementTypeProp

Get the element type properties
Deck of Cards
idbimGetElementTypeProp
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: element-types/<element_type_id> 

URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types/<element_id>

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9

Card
labelHTTP Method
 GET
Card
labelDescription
 Get the properties of a specified element type.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSONlangxml
{
    "type": "ChimneyDoorOpening",
    "category": "/5/1/10/8/",
    "name": "ChimneyID_ArchDoorOpening",
    "ifcType": "ID_IFCBuildingElementProxyIFCOpeningElement",
    "id": "e504f24c9eaf09c4-e6431f56-452b43ee-b901b008-6a18883dc7e95291ec50e7e1"
}

Anchor
getDisciplines
getDisciplines

Get the list of existing layers
Deck of Cards
idbimGetDisciplines
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: element-types/disciplines 

URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types/disciplines

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/disciplines

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the list of existing layers.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSONlangxml
{
  "0f106af0-e79a4e18a919-383f44c5-49c4-aabf-e15b27850423b211-15bd5ef620b6": {
    "category": "/141/",
    "name": "AirconditionermodelID_BuildingModel",
    "ifcType": null,
    "id": "e79a4e180f106af0-383fa919-49c444c5-aabfb211-e15b2785042315bd5ef620b6"
  },
  "a330fde2-63b069d21a2f-81df48ed-4418-91de-8a954fa12924a6e3-90b92965dca6": {
    "category": "/519/",
    "name": "Wood Construction Model"
ifcType"ID_CollisionModel",
    "ifcType": null,
    "id": "63b069d2a330fde2-81df1a2f-441848ed-91dea6e3-8a954fa1292490b92965dca6"
  },
  "35f37a1e-dd5cc7d0c724-72fe453d-46aa-ba62-dcd86729bd2fa994-6381655ba38f": {
    "category": "/415/",
    "name": "MassiveconstructionmodelID_ConstructionSiteModel",
    "ifcType": null,
    "id": "dd5cc7d035f37a1e-72fec724-46aa453d-ba62a994-dcd86729bd2f6381655ba38f"
  },
-6a6e4d09-3550-4483-8134-98ac1e6c1afb: {
category: "/60/"
name: "Production model"
ifcType: null
id: "6a6e4d09-3550-4483-8134-98ac1e6c1afb"
}
-09e623d4-1e12-4a77-b358-ea1d0b28e4a7: {
category: "/2/"
name: "Roommodel"
ifcType: null
id: "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
}
-687c6451-3fa1-47e0-9f13-406833bb06f3: {
category: "/13/"
name: "TGA_Wastewatermodel"
ifcType: null
id: "687c6451-3fa1-47e0-9f13-406833bb06f3"
}
}
...
  ...
}

 

 

Anchor
getElementTypesOfDiscipline
getElementTypesOfDiscipline

Get all element types of a layer

Deck of Cards
idbimElementTypesOfDiscipline
Card
labelURL / Resource / JSON structure

Resource: element-types

URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types/disciplines/<discipline_id>

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/disciplines/0f106af0-a919-44c5-b211-15bd5ef620b6

Card
labelHTTP Method

GET

Card
labelDescription

Get all element types of given layer

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
[
  {
    "type": "Column",
    "category": "/1/10/2/",
    "name": "ID_ArchColumn",
    "ifcType": "ID_IFCColumn",
    "id": "2e308afe-d078-4c20-b53c-76b2da66d848"
  },
  {
    "type": "Foundation",
    "category": "/1/10/6/",
    "name": "ID_ArchFoundation",
    "ifcType": "ID_IFCFooting",
    "id": "3a508cf2-bb2f-4cc5-9b8c-fbc1a5848bba"
  },
  ...
]

Anchor
getElementTypesTopology
getElementTypesTopology

Get all element types in a tree view

Deck of Cards
idbimElementTypesTopology
Card
labelURL / Resource / JSON structure

Resource: element-types

URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types/topology

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/topology

Card
labelHTTP Method

GET

Card
labelDescription

Get all Bimplus element types in a tree view

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
[
...
        {
          "type": "BuildingObject",
          "layer": "BuildingModel",
          "name": "ID_Bauteilobjekte",
          "children": [
            {
              "type": "Wall",
              "layer": "BuildingModel",
              "name": "ID_ArchWall",
              "children": null,
              "category": "/1/10/1/",
              "ifcType": "ID_IFCWallStandardCase",
              "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
            },
            {
              "type": "Column",
              "layer": "BuildingModel",
              "name": "ID_ArchColumn",
              "children": null,
              "category": "/1/10/2/",
              "ifcType": "ID_IFCColumn",
              "id": "2e308afe-d078-4c20-b53c-76b2da66d848"
            },

  ...
]