Page History

...

Deck of Cards

id	bimGetBimAttributes

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributes

URL: https://api-stage.bimplus.net/v2/content/freeattributes

Example: https://api-stage.bimplus.net/v2/content/freeattributes?filter=name=Gross Filter: When filter

Optional query parameters

Name	Type	Default value	Description
filter	string		When filter "name=Gross" is defined the API will return only free attributes which

Type

Name contains requested sub-string,
e.g. if filter is "name=Gross" will be returned all free attributes which Name contains substring "Gross".
Like GrossFloorArea, GrossWallArea, GrossWeight etc.

Card

label	HTTP Method

GET

Card

label	Description

Get all the free attributes from the Bimplus DB

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

 [
    {
        "parent": "5d184904-fab5-4e53-9916-e9c20c4e31b7",
        "type": null,
        "id": "8d3d9dd5-c998-465b-b13e-87901c90f3bc",
        "name": "heat transfer coefficient"
    },
    {
        "parent": "5d184904-fab5-4e53-9916-e9c20c4e31b7",
        "type": null,
        "id": "a6645047-39ee-4c87-9fc3-14ccca0c50ac",
        "name": "density"
    },
    {
        "parent": "431754db-32e6-4fc4-b252-a647b94aa5a8",
        "type": null,
        "id": "8807e401-6e3c-4536-88e1-e834d4de745d",
        "name": "floor area"
    },
    {
        "parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
        "type": null,
        "id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
        "name": "bend radius"
    },
.....
]

...

Deck of Cards

id	bimGetBimUnitList

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

URL: https://api-stage.bimplus.net/v2/content/units

Example: https://api-stage.bimplus.net/v2/content/unitsFilter:

Optional query parameters

Name	Type	Default value	Description
symbol	string		When symbol "kg" is defined the API returns all the unit with the specified symbol name. e.g. "https://api-stage.bimplus.net/v2/content/units?symbol=

<symbolname>", returns all the unit with the specified symbol name.

kg"

Card

label	HTTP Method

GET

Card

label	Description

Get all the units from Bimplus DB.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
    "unit": "€",
    "contextUnitType": "CURRENCYUNIT",
    "id": "85fae1e9-5774-4bce-9831-911c8ff0d6b2",
    "name": "Currency",
    "description": "base unit for currency"
  },
  {
    "unit": "W/(m2*K)",
    "contextUnitType": "THERMALTRANSMITTANCEUNIT",
    "baseunits": [
      {
        "baseunitid": "cbd91636-49fa-4a4f-bdcc-03f27ca205f8",
        "usequence": 1,
        "ufactor": 1,
        "upower": -1
      }
    ],
    "id": "32ef9505-baa6-4598-b372-8e050aef57d4",
    "name": "Watt_per_square_meter_per_Kelvin",
    "description": "unit for heat transfer coefficient"
  },
  {
    "unit": "mm",
    "contextUnitType": "LENGTHUNIT",
    "baseunits": [
      {
        "baseunitid": "7be3452a-47f9-4fd8-bd94-ef6c967d684e",
        "usequence": 1,
        "ufactor": 0.001,
        "upower": 1
      }
    ],
    "id": "f99f40cf-da64-4c4f-8434-cb90722ba485",
    "name": "mm",
    "description": "unit for length in millimeter"
  },
......
]

...

Deck of Cards

id	bimGetElementForTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: element-types/attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/attributetemplates?filter=type=Wall

Filter: When filter is defined the API will return only element-types which Type contains requested sub-string, e.g. if filter is "type=Wall" will be returned all element-types which Type contains substring "Wall". Like Wall, CurtainWall, WallCovering, StructuralAnalysisWall, etc.

Optional query parameters

Name

Type

Default value

Description

filter

string

When filter "type=Wall" is defined the API will return only element-types which Type contains requested sub-string,

e.g. if filter is "type=Wall" will be returned all element-types which Type contains substring "Wall".

Like Wall, CurtainWall, WallCovering, StructuralAnalysisWall, etc.

Card

label	HTTP Method

GET

Card

label	Description

Retrieve a list of element-types to which an attribute template can be assigned. Please remember that attribute template can't be assigned to all element-types (i.e v2/<team_slug>/element-types)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

 [
    {
        "type": "BuildingObject",
        "category": "/1/",
        "name": "ID_BuildingModel",
        "ifcType": null,
        "id": "0f106af0-a919-44c5-b211-15bd5ef620b6"
    },
    {
        "type": "BuildingElement",
        "category": "/1/10/",
        "name": "ID_Bauteilobjekte",
        "ifcType": null,
        "id": "34c606d8-77aa-4c1c-a19d-cf9cf222e6c5"
    },
    {
        "type": "Wall",
        "category": "/1/10/1/",
        "name": "ID_ArchWall",
        "ifcType": "ID_IFCWallStandardCase",
        "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
    },
.....]

...

Deck of Cards

id	bimGetTemplatesFromElement

Card

default	true
label	URL / Resource / JSON Structure

Resource: element-types/<element_id>/attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/10074eef-9418-4d64-9c6d-23932835a7f1/attributetemplates

Optional query parameters

Name

Type

Default value

Description

attributes

string (bool)

false

By default the response doesn't include the free attribute list in returned attribute templates.

To include the free attribute list, please use the query parameter attributes=true.

e.g. https://api-stage.bimplus.net/v2/bimplus/element-types/10074eef-9418-4d64-9c6d-23932835a7f1/attributetemplates?attributes=true

projectattributetemplate

string (Guid)

undefined

By default in the response are included attribute templates from all project attribute templates defined in team which belongs to requested element-type.

To be included only attribute templates which belongs to certain project attribute template, please use the projectAttributeTemplate query parameter.

e.g. https://api-stage.bimplus.net/v2/bimplus/element-types/10074eef-9418-4d64-9c6d-23932835a7f1/attributetemplates?projectattributetemplate=bb6ccf01-75f1-4581-842a-95bbe71f7285

Card

label	HTTP Method

GET

Card

label	Description

Get all the free attribute groups from the Bimplus DB

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

 [
    {
        "name": "Element (default Property set)",
        "description": "",
        "created": "2015-10-29T00:13:30.393",
        "createdby": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "changed": "2015-10-29T00:13:30.393",
        "changedby": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
        "id": "3f025e20-1c11-42b1-ad3b-0f6cc6fc03af"
    }
]

projectattributetemplate

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 67

New Version 68

Key