Page History

Info
This page is under construction

Custom attribute Service

...

Bimplus DB

...

Important: All the APIs described in the Bimplus DB section applies to the Team DB as well. Replace the keyword "content" with the "team_slug" for working with the custom attributes & attribute groups in Team DB.

eg: Bimplus DB: https://api-stage.bimplus.net/v2/content/freeattributegroups. Similar call in Team DB will be https://api-stage.bimplus.net/v2/<team_slug>/freeattributegroups.

Team DB contains some additional APIs for working with attribute templates which are specified in this section.

Project Attribute Templates

Attribute Templates

Element-type filter

Anchor

	customAttributeService
	customAttributeService

...

Deck of Cards

id	bimCreateBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroups

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the attribute group
description	optional	string	Short description of the attribute group
parent	optional	string (guid)	Parent attribute group. If not specified, then the created group is a stand-alone group
children	will be ignored	json	Sub groups

Card

label	HTTP Method

POST

Card

label	Description

Creates a new custom attribute group. The created group could be either stand-alone ( parent not specified ), or created inside another group (the id of the parent has to be specified)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
  "name": "TestGroup",
  "description": "Test group",
  "parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 201 Created

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
  "id": "da9c6db5-92fa-473d-9282-483c40907a95",
  "name": "TestGroup",
  "description": "Test group",
  "parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}

...

Deck of Cards

id	bimgetBIMAttributeGroupList

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroups

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

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

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	lang	xml

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

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

 [
    {
        "id": "81a39304-9d4a-4e8d-826e-7736b9350562",
        "name": "ALLFA Attributes",
        "description": ""
    },
    {
        "id": "e6b44081-8983-4c07-b1a7-2c43bc199927",
        "name": "Allplan Attributes",
        "description": ""
    },
    {
        "id": "af12dda5-dafe-4b05-adeb-638617cc6907",
        "name": "BaseQuantities",
        "description": ""
    },
    {
        "children": [
            {
                "parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
                "id": "170820da-de29-437a-aa97-f7984a319890",
                "name": "Element",
                "description": "tabAttribbElement"
            },
            {
                "parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
                "id": "af946941-5a14-4c6a-be9f-424ca59b10b5",
                "name": "Element State",
                "description": "tabAttribbElementState"
            },
            {
                "parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
                "id": "0f6906f2-305d-4899-979a-6ce1e49af6a9",
                "name": "General",
                "description": "tabAttribGeneral"
            },
            {
                "parent": "073245c3-6ed4-40a0-9146-ecd1eb111500",
                "id": "66c2ba5e-8a70-40b8-9918-fccd1663f3bb",
                "name": "IFC",
                "description": "tabAttribIFC"
            }
        ],
        "id": "073245c3-6ed4-40a0-9146-ecd1eb111500",
        "name": "Bimplus Property Sets",
        "description": ""
    },
    {
        "id": "5d184904-fab5-4e53-9916-e9c20c4e31b7",
        "name": "Building Attribute",
        "description": ""
    },
    {
        "id": "1b567ec2-4a10-43ba-b791-45f288866808",
        "name": "CostPlanning",
        "description": "DIN276"
    },
    {
        "id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
        "name": "Engineering Attributes",
        "description": ""
    },
    {
        "id": "1d9b883c-ecf5-4b91-b6a0-adea66432f6c",
        "name": "Identity Data",
        "description": ""
    },
    {
        "children": [
            {
                "parent": "99b99afa-abed-4a9e-99be-f2d3a2cb29de",
                "id": "6f496c13-e153-4ebd-8662-f00fe3e81e20",
                "name": "Pset_StairCommon",
                "description": ""
            }
        ],
        "id": "99b99afa-abed-4a9e-99be-f2d3a2cb29de",
        "name": "IFC",
        "description": ""
    },
    {
        "id": "cf83b687-b7ff-466b-9c15-853488455c5b",
        "name": "MEP Attribute",
        "description": ""
    },
    {
        "id": "969df3d1-5e79-4eea-aca9-5758d0026b39",
        "name": "Pset_[EType]Common",
        "description": ""
    },
    {
        "id": "431754db-32e6-4fc4-b252-a647b94aa5a8",
        "name": "Space Attributes",
        "description": ""
    }
]

...

Deck of Cards

id	bimGetBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroups

URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<attributegroup_id>

Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular free attribute group and its sub-groups(hierarchy) It doesn't return the free attributes under this group.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
    "id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
    "name": "Engineering Attributes",
    "description": ""
}

...

Deck of Cards

id	bimUpdateBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroups

URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<id>

Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatoryoptional	string	Name of the attribute group
description	optional	string	Short description of the attribute group
id	will be ignored	string (guid)	Id of the free attribute group

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular free attribute group. It is also possible to move the group as a sub-group of another group by changing its parent

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "name": "Engineering Attributes",
    "description": "updated description"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "id": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
    "name": "Engineering Attributes",
    "description": "updated description"
}

...

Deck of Cards

id	bimDeleteBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroups

URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<id>

Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified attribute group.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Anchor

	createBimFreeAttribute
	createBimFreeAttribute

...

Deck of Cards

id	bimCreateBimFreeAttribute

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the attribute
description	optional	string	Short description of the attribute
type	mandatory	string	Type of free attributes. It could be one of the following: "int", "double", "string", "guid", "datetime", "binary", "boolean"
minvalue	optional	string(numbers)	Minimum value constraint of the attribute
maxvalue	optional	string(numbers)	Maximum value constraint of the attribute
defaultvalue	optional	string(numbers)	Default value of the attribute (if it's value is not specified)
decimal	optional	int	Number of decimals
unitid	optional	string(guid)	Id of the unit
optionalsymbol	optional	string(symbol)	Optional symbol
visible	optional	int	0 or 1. It determines whether the attribute should be visible
changeable	optional	int	0 or 1. It determines whether the attribute should be chnageable
controltype	optional	string	The control type (eg: "textbox"Checkbox", "Datepicker", "TextBox", "Enumeration", "Combobox")
symbol	will be ignored	string	Symbol of the unit
parent	optional	string(guid)	Id of the attribute group. If not specified, then the created attribute is a stand-alone one.

Card

label	HTTP Method

POST

enumDefinition

optional,

mandatory for controltypes:

"Enumeration", "Combobox"

string

Mandatory for controltype "Enumeration"

List of items - pair of key,value separated with semicolon (";") Separator of key and value is character pipe ("|")

Mandatory for controltype "Combobox"

List of items - values separated with character pipe ("|")

symbol

will be ignored

string

Symbol of the unit

parent

optional

string(guid)

Id of the attribute group. If not specified, then the created attribute is a stand-alone one.

Card

label	HTTP Method

POST

Card

label	Description

Card

label	Description

Creates a new custom attribute. The created attribute could be either stand-alone ( parent not specified ), or part of the custom attribute group (the id of the parent has to be specified)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

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

Code Block

lang

borderColor	Red
lang	xml
title	JSON	xml

{
 "name": "NewFreeAttribute",
 "description": "Test attribute",
 "type": "int",
 "minvalue" : "1",
 "maxvalue" : "1000",
 "defaultvalue" : "1",
 "decimal" : "0",
 "attribunitnameid" : "F99F40CF-DA64-4C4F-8434-CB90722BA485",
 "optionalsymbol" : "$",
 "visible" : "1",
 "changeable" : "1",
 "controltype" : "textbox",
 "parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}

Card

label	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
  "freeattribtype": "int",
  "minvalue": "1",
  "maxvalue": "1000",
  "defaultvalue": "1",
  "decimal": 0,
  "attribunitnameid": "f99f40cf-da64-4c4f-8434-cb90722ba485", --> unitId (we already know it is attribute)
  "symbol": "mm",
  "optionalsymbol": "$",
  "visible": 1,
  "changeable": 1,
  "controltype": "textbox", --> The client should decide
  "id": "d6cac39a-4b6e-473f-813f-87f7fb92d3fe",
  "name": "NewFreeAttribute",
  "description": "Test attribute",
  "parent" : "6e57160e-5d5d-46a4-b4d3-b9e46d03ee75"
}

...

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

Optional query parameters

Name	Type	Default value	Description
filter	string		When filter "name=Gross" is defined the API will return only free attributes which 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	lang	xml

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

Card

label	Response

Code Block

borderColor	Green	title	Status
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

 [
    {
        "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	bimGetBimAttributesFromGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: freeattributes

URL: https://api-stage.bimplus.net/v2/content/freeattributegroups/<attributegroup_id>/freeattributes

Example: https://api-stage.bimplus.net/v2/content/freeattributegroups/b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8/freeattributes

Card

label	HTTP Method

GET

Card

label	Description

Get all the free attributes under a attribute group

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

 [
    {
        "parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
        "type": "double",
        "minvalue": "0",
        "decimal": 2,
        "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
        "unit": "mm",
        "visible": 1,
        "changeable": 0,
        "controltype": "TextBox",
        "id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
        "name": "bend radius",
        "description": "bend diameter for reinforcement bars"
    },
    {
        "parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
        "type": "double",
        "minvalue": "0",
        "defaultvalue": "5",
        "decimal": 2,
        "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
        "unit": "mm",
        "visible": 1,
        "changeable": 0,
        "controltype": "TextBox",
        "id": "c4623c1b-dfd3-4117-af37-091eaaff60bf",
        "name": "concrete cover",
        "description": "the least distance between the surface of embedded reinforcement and the outer surface of the concrete"
    },
    {
        "parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
        "type": "int",
        "decimal": 0,
        "visible": 1,
        "changeable": 0,
        "controltype": "TextBox",
        "id": "1c838554-3692-4ed4-afaf-989a9e59252b",
        "name": "SteelGrade",
        "description": "Kurzbez. der Stahlgüte @495@"
    },
    {
        "parent": "b03b5eb0-58f0-40a7-95fb-cb36b6f14cc8",
        "type": "int",
        "decimal": 0,
        "visible": 1,
        "changeable": 0,
        "controltype": "TextBox",
        "id": "d7ab92f4-ddf1-404b-8875-57b25b8fe66a",
        "name": "CrossSectionNumber",
        "description": "Nummer der Querschnittsreihe @496@"
    }
]

...

Deck of Cards

id	bimGetBimAttributeInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributes

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

Example: https://api-stage.bimplus.net/v2/content/freeattributes/c4623c1b-dfd3-4117-af37-091eaaff60bf

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular free attribute in Bimplus DB

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "type": "double",
    "minvalue": "0",
    "defaultvalue": "5",
    "decimal": 2,
    "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
    "unit": "mm",
    "visible": 1,
    "changeable": 0,
    "controltype": "TextBox",
    "id": "c4623c1b-dfd3-4117-af37-091eaaff60bf",
    "name": "concrete cover",
    "description": "the least distance between the surface of embedded reinforcement and the outer surface of the concrete"
}

...

Deck of Cards

id	bimUpdateBimAttribute

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributes

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

Example: https://api-stage.bimplus.net/v2/content/freeattributes/c4623c1b-dfd3-4117-af37-091eaaff60bf

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	Id of the free attribute
name	mandatoryoptional	string	Name of the attribute
description	optional	string	Short description of the attribute
type	mandatoryoptional	string	Type of free attributes. It could be one of the following: "int", "double", "string", "guid", "datetime", "binary", "boolean"
minvalue	optional	string(numbers)	Minimum value constraint of the attribute
maxvalue	optional	string(numbers)	Maximum value constraint of the attribute
defaultvalue	optional	string(numbers)	Default value of the attribute (if it's value is not specified)
decimal	optional	int	Number of decimals
unitid	optional	string(guid)	Id of the unit
optionalsymbol	optional	string(symbol)	Optional symbol
visible	optional	int	0 or 1. It determines whether the attribute should be visible
changeable	optional	int	0 or 1. It determines whether the attribute should be chnageable
controltype	optional	string	The control type (eg: "textboxCheckbox", "Datepicker", "TextBox", "Enumeration", "Combobox")
symbol	will be ignored	string	Symbol of the unit
enumDefinition	optional, mandatory for controltypes: "Enumeration", "Combobox"	string	Mandatory for controltype "Enumeration" List of items - pair of key,value separated with semicolon (";") Separator of key and value is character pipe ("\|") (eg: "0\|Undefined;1\|Extension;2\|Finish;3\|New building;4\|Reconstruction;5\|Building alteration") Mandatory for controltype "Combobox" List of items - values separated with character pipe ("\|") (eg: "Undefined\|Extension\|Finish\|New building\|Reconstruction\|Building alteration")
symbol	will be ignored	string	Symbol of the unit
parent	optional	string(guid)	Id of the attribute	parent	optional	string(guid)	Id of the attribute group. It is also possible to move attribute to another group by changing its parent

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular free attribute. It is also possible to move attribute to another group by changing its parent.

Card

label	Request

Code Block

borderColor	Green
titlelang	Headersxml
langtitle	xmlHeaders

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "description": "updated description"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "type": "double",
    "minvalue": "0",
    "defaultvalue": "5",
    "decimal": 2,
    "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
    "unit": "mm",
    "visible": 1,
    "changeable": 0,
    "controltype": "TextBox",
    "id": "c4623c1b-dfd3-4117-af37-091eaaff60bf",
    "name": "concrete cover",
    "description": "updated description"
}

...

Card

...

label

...

Delete a particular free attribute

Deck of Cards

id	bimDeleteBimAttribute

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributes

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

Example: https://api-stage.bimplus.net/v2/content/freeattributes/c4623c1b-dfd3-4117-af37-091eaaff60bf

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specific attribute.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "type": "double",
    "minvalue": "0",
    "defaultvalue": "5",
    "decimal": 2,
    "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
    "unit": "mm",
    "visible": 1,
    "changeable": 0,
    "controltype": "TextBox",
    "id": "c4623c1b-dfd3-4117-af37-091eaaff60bf",
    "name": "concrete cover",
    "description": "updated description"
}

Anchor

	deleteBimAttribute
	deleteBimAttribute

Delete a particular free attribute

Deck of Cards

id	bimDeleteBimAttribute

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributes

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

Example: https://api-stage.bimplus.net/v2/content/freeattributes/c4623c1b-dfd3-4117-af37-091eaaff60bf

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specific attribute.

...

Create a new unit in Bimplus DB

Deck of Cards

id	bimcreateBimUnit

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/units

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the unit
description	optional	string	Short description of the unit
symbol	mandatory	string	Symbol of the unit
baseunitid	optional	string(guid)	Specify this property for deriving a unit from a base unit
usequence	optional	int	Unit sequence (default is 1)
upower	optional	int	Unit power (default is 1)
ufactor	optional	int	Unit factor (default is 1)

Card

label	HTTP Method

POST

Card

label	Description

Creates a new unit. An unit can be created fresh(base unit) or we can derive an unit from a base unit by specifying the baseunitid

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	RedGreen
titlelang	JSONxml
langtitle	xmlStatus

{
Status:  "name": "MyDerivedUnit",
  "description": "Example of derived unit",
  "symbol": "Sym",
  "baseunitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
  "usequence": 1,
  "ufactor": 2,
  "upower": 3
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "symbol": "Sym",
  "baseunitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
  "usequence": 1,
  "ufactor": 2.0,
  "upower": 3,
  "id": "9c75f2e7-bf66-4274-96a6-fb61ecb0e21a",
  "name": "MyDerivedUnit",
  "description": "Example of derived unit"
}

...

200 OK

Anchor

	createBimUnit
	createBimUnit

Create a new unit in Bimplus DB

Deck of Cards

id	bimcreateBimUnit

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/units

JSON Structure of unit:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the unit
description	optional	string	Short description of the unit
unit	mandatory	string	Symbol of the unit
contexUnitType	optional	string	Context unit type
baseunits	optional	array of jsons	List of base units

The "baseunits" property is an array of jsons with following definitions :

Name	Mandatory/Optional	Type	Description
baseunitid	optional	string(guid)	Base unit ID
usequence	optional	int	Unit sequence (default is 1)
upower	optional	int	Unit power (default is 1)
ufactor	optional	int	Unit factor (default is 1)

Card

label	HTTP Method

POST

Card

label	Description

Creates a new unit. An unit can be created fresh(base unit) or it can be derived from one or more base units ( defined by property "baseunits" ).

Here is a simple explanation of how to create a derived unit, e.g. gram per square meter "g/m2" :

Code Block

title	json description

"baseunits": [

...

Get all the units from Bimplus DB

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/units

Filter: https://api-stage.bimplus.net/v2/content/units?symbol=<symbolname>", returns all the unit with the specified symbol name.

Card

label	HTTP Method

GET

Card

label	Description

Get all the units from Bimplus DB.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "unitbaseunitid": "kg3b871b65-516e-4e7e-a35f-faa7501d5d0d",
 // ID of    kilogram "contextUnitType": "MASSUNIT",kg"
        "idusequence": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
1,   // first in   "name": "kilogram",the sequence
        "descriptionufactor": "base unit for mass"
    },0.001, // gram is 0.001 * kg
    {
    "upower": 1       // no "unit": "m",
power used
      },
     "contextUnitType": "LENGTHUNIT", {
        "idbaseunitid": "7be3452a-47f9-4fd8-bd94-ef6c967d684e",
  // ID of   meter "name": "meter",m"
        "descriptionusequence": "base2, unit for length"
// second in  },
    {the sequence
        "unitufactor": "s"1,
     // 1  "contextUnitType": "TIMEUNIT",* meter
        "idupower": "456e899b-2bda-49a5-8e6f-e1ff8bfd9e14",
-1      // meter ^-1
      }
    ]

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "secondMyDerivedUnit",
  "description": "Example of derived unit",
  "descriptionsymbol": "Sym"base unit for time"
,
  "baseunits" : [
      },{
    {
        "unitbaseunitid": "K3b871b65-516e-4e7e-a35f-faa7501d5d0d",
            "contextUnitTypeusequence": "THERMODYNAMICTEMPERATUREUNIT"1,
            "idufactor": "cbd91636-49fa-4a4f-bdcc-03f27ca205f8"2,
        "name": "kelvin",
        "descriptionupower": "base3
 unit for thermodynamic temperature"
  }
  ]
},
......
]

...

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id": "9c75f2e7-bf66-4274-96a6-fb61ecb0e21a",
  "name": "MyDerivedUnit",
  "description": "Example of derived unit",
  "symbol": "Sym",
  "baseunits" : [
      {
            "baseunitid

...

Get the info about a particular unit in Bimplus DB

Deck of Cards

id	bimGetBimUnit

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular unit in Bimplus DB.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "unit": "kg",
    "contextUnitType": "MASSUNIT",
    "id": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
            "nameusequence": "kilogram"1,
            "descriptionufactor": "base unit for mass"
 2,
            "upower": 3
      }
  ]
}

Anchor

	updateBimUnitgetBimUnitList	updateBimUnit

...

	getBimUnitList

Get all the units from Bimplus DB

Deck of Cards

id	updateBimUnitbimGetBimUnitList

Card

default	true
label	URL / Resource / JSON Structure

Resource: content content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0dJSON Structure:

Optional query parameters

Name	Mandatory / Optional	Type	Default valueType
idsymbol	will be ignored	string(guid)	id of the unit
name	mandatory	string	Name of the unit
description	optional	string	Short description of the unit
symbol	mandatory	string	Symbol of the unit
baseunitid	optional	string(guid)	Specify this property for deriving a unit from a base unit
usequence	optional	int	Unit sequence (default is 1)
upower	optional	int	Unit power (default is 1)
ufactor	optional	int	Unit factor (default is 1)
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=kg"

Card

label	HTTP Method

GET

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular unit Get all the units from Bimplus DB.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Red	title	JSONGreen
lang	xml

{
    "description": "updated description"
}

Card

label	Response


title	Status

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

[
    {
    "unit": "kg€",
    "contextUnitType": "MASSUNITCURRENCYUNIT",
    "id": "3b871b6585fae1e9-516e5774-4e7e4bce-a35f9831-faa7501d5d0d911c8ff0d6b2",
    "name": "kilogramCurrency",
    "description": "updated descriptionbase 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"
  },
......
]

Anchor

	getBimUnit
	getBimUnit

Get the info about a particular unit in Bimplus DB

Deck of Cards

id	bimGetBimUnit

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

...

Delete a particular unit

Deck of Cards

id	bimDeleteBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the specific unit.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Create an attribute template

Deck of Cards

id	bimCreateTeamTemplate

List of element type ids

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates

JSON Structure:

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the attribute template

description

optional

string

Short description of the attribute template

freeattributes

mandatory

JSON Array

List of free attribute ids

elementtypes

mandatory

JSON Array

Card

label	HTTP Method

POST GET

Card

label	Description

Creates a new attribute template using free attributes & element types Get the info about a particular unit in Bimplus DB.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

card

Card

label	Response

Code Block

borderColor	RedGreen
titlelang	JSONxml
langtitle	xmlStatus

{
Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "unit": "mm",
    "contextUnitType "name": "Attribute Template 1",
  "description": "Testing templateLENGTHUNIT",
    "freeattributesbaseunits": [
      {
        "Idbaseunitid": "5EED72757be3452a-0B0D47f9-41D54fd8-A13Ebd94-0C1C1FA87B33"
    }ef6c967d684e",
    {
      "Idusequence": "67900FFF-A744-4EA3-A0DC-4140E424B756"
    }1,
    {
      "Idufactor": "B5850E23-B1DF-4D4F-AAE8-CEE0D4BB06E6"0.001,
    }
  ],
  "elementtypesupower": [1
      {}
    ],
    "id": "F18DE608f99f40cf-0F7Fda64-40E34c4f-A0F78434-8088778D18CBcb90722ba485",
     },
    {
  "name": "mm",
    "iddescription": "F8E1D9E3-82C0-4F14-8337-7FE568117616"
    }unit for length in millimeter"
  ]
}

Anchor

...

	updateBimUnit
	updateBimUnit

Update a particular unit

Deck of Cards

id	updateBimUnit

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

JSON Structure: See Create Unit

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular unit.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "MyDerivedUnit updated",
  "description": "Example of derived unit",
  "symbol": "Sym",
  "baseunits" : [
      {

Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "Attribute Template 1",
  "description": "Testing template",
  "elementtypes": [
    {
      "type": "not implemented",
      "category": "/7/1/10/",
      "name": "ID_Wandobjekte",
      "ifcType": "ID_IFCWall",
      "id": "f8e1d9e3-82c0-4f14-8337-7fe568117616"
    },
    {
      "type": "not implemented",
      "categorybaseunitid": "/3b871b65-516e-4e7e-a35f-faa7501d5d0d",
      "name": "ID_Hall",
      "ifcTypeusequence": null1,
      "id": "f18de608-0f7f-40e3-a0f7-8088778d18cb"
    }
 "ufactor": ]2,
  "freeattributes": [
    {
      "typeupower": "double",3
      "minvalue": "0",}
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "decimalid": 2"9c75f2e7-bf66-4274-96a6-fb61ecb0e21a",
  "name": "MyDerivedUnit updated",
  "unitiddescription": "f99f40cf-da64-4c4f-8434-cb90722ba485Example of derived unit",
      "unitsymbol": "mmSym",
      "visiblebaseunits" : 1,[
      "changeable": 1,{
      "controltype": "TextBox",
      "idbaseunitid": "b5850e233b871b65-b1df516e-4d4f4e7e-aae8a35f-cee0d4bb06e6faa7501d5d0d",
      "name": "bend radius",
      "descriptionusequence": "bend diameter for reinforcement bars"
    },
1,
      {
      "typeufactor": "double"2,
      "decimal": 2,
      "unitidupower": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",3
      "unit": "kg",}
      "visible": 1,
      "changeable": 1,
      "controltype": "TextBox",
      "id": "5eed7275-0b0d-41d5-a13e-0c1c1fa87b33",
      "name": "double value",
      "description": ""
    },
    {
      "type": "int",
      "minvalue": "1",
      "maxvalue": "1000",
      "defaultvalue": "1",
      "decimal": 0,
      "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
      "unit": "mm",
      "optionalunit": "milimeter",
      "visible": 1,
      "changeable": 1,
      "controltype": "textbox",
      "id": "67900fff-a744-4ea3-a0dc-4140e424b756",
      "name": "NewFreeAttribute1_G2",
    ]
}

Anchor

	deleteBimUnit
	deleteBimUnit

Delete a particular unit

Deck of Cards

id	bimDeleteBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the specific unit.

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

Anchor

	createTeamProjectAttributeTemplate
	createTeamProjectAttributeTemplate

Create new project attribute template in team

Deck of Cards

id	bimCreateTeamProjectAttributeTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Unique name of the project attribute template
description	optional	string	Short description of the project attribute template

Card

label	HTTP Method

POST

Card

label	Description

Creates a new project attribute template.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My project attribute template",
  "description": "Project attribute template for my team",
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My project attribute template",
  "description": "TestProject attribute"
 template for  }
  ],
  "created": "2015-04-23T05:42:52.91",
  "createdby": {
  my team",
  "id": "7c55589949d13da3-5a5f2acf-44d14f0b-930eb667-284930678bed40fc0197585f",
    "email": "sslacky@nemetschek.com"
  },
  "id": "3e5c0964-8f28-469b-b176-bcfad48f2eef"
}

Anchor

	getTeamTemplatesgetTeamProjectAttributeTemplatesgetTeamTemplates
	getTeamProjectAttributeTemplates

Get

...

the list of existing project attribute templates

...

in team

Deck of Cards

id	bimGetTeamTemplatesbimGetTeamProjectAttributeTemplates

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates projectattributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplatesprojectattributetemplates

Card

label	HTTP Method

GET

Card

label	Description

Get all the project attribute templates that belongs to a team. Each team has at least one default project attribute template.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

[
    {
    "name": "Default",
    "namedescription": "Template 1Default project attribute template",
        "createdid": "2015-10-27T09:22:13.27",0149c4a8-4e84-4c40-bfdd-5dd63b109266"
  },
  {
    "createdbyname": {
"My project           "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72edattribute template",
            "emaildescription": "jayaraj.purushothaman@gmail.com"
        },
    Project attribute template for my team",  
    "changedid": "2015-10-27T09:32:05.27",
        "changedby": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "id": "511f1724-3848-49a2-8b21-77180b61edc0"
    }
]

...

49d13da3-2acf-4f0b-b667-40fc0197585f"
  }
]

Anchor

	getProjectAttributeTemplateInfo
	getProjectAttributeTemplateInfo

Get the info about a particular project attribute template

...

Deck of Cards

id	bimGetBimUnitbimGetProjectAttributeTemplateInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units projectattributetemplates

URL: https://api-stage.bimplus.net/v2/content<team_slug>/unitsprojectattributetemplates/<unit<projectattributetemplates_id>

Example: https://api-stage.bimplus.net/v2/contentbimplus/unitsprojectattributetemplates/3b871b6549d13da3-516e2acf-4e7e4f0b-a35fb667-faa7501d5d0d40fc0197585f

Card

label	HTTP Method

GET

Card

label	Description

Get Get the info about a particular unit in Bimplus DB project attribute template that belongs to a particular team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

 {
    "unitname": "kg",
My project   "contextUnitType": "MASSUNIT"attribute template",
    "iddescription": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
    "name": "kilogram",Project attribute template for my team",  
    "descriptionid": "base unit for mass49d13da3-2acf-4f0b-b667-40fc0197585f"
 }

Anchor

	updateBimUnitupdateTeamProjectAttributeTemplateupdateBimUnit
	updateTeamProjectAttributeTemplate

...

Update a particular

...

project attribute template

Deck of Cards

id	updateBimUnitbimUpdateTeamProjectAttributeTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units projectattributetemplates

URL: https://api-stage.bimplus.net/v2/content/units/<id><team_slug>/projectattributetemplates

Example: https://api-stage.bimplus.net/v2/contentbimplus/unitsprojectattributetemplates/3b871b6549d13da3-516e2acf-4e7e4f0b-a35fb667-faa7501d5d0d40fc0197585f

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	id of the unit
name	mandatory	string	Name of the unit
description	optional	string	Short description of the unit
symbol	mandatory	string	Symbol of the unit
baseunitid	optional	string(guid)	Specify this property for deriving a unit from a base unit
usequence	optional	int	Unit sequence (default is 1)
upower	optional	int	Unit power (default is 1)
ufactor	optional	int	Unit factor (default is 1)

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular unit.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "description": "updated description"
}

See Create project attribute template

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular project attribute template that belongs to a particular team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "My project attribute template2",
    "description": "Project attribute template for my team2",  
 }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My project attribute template2",
  "description": "Project attribute template for my team2",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	deleteTeamProjectAttributeTemplate
	deleteTeamProjectAttributeTemplate

Delete the project attribute template

Deck of Cards

id	bimDeleteTeamProjectAttributeTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates/49d13da3-2acf-4f0b-b667-40fc0197585f

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the specific project attribute template.

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

Anchor

	copyContentProjectAttributeTemplate
	copyContentProjectAttributeTemplate

Copy attribute templates from source to target project attribute template

Deck of Cards

id	bimCopyContentProjectAttributeTemplate

Card

label	Url / Resource /Json

Resource: projectattributetemplates/<targetprojectattributetemplates_id>/copyfrom

URL: https://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplates/<targetprojectattributetemplates_id>/copyfrom

Example:https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates/49d13da3-2acf-4f0b-b667-40fc0197585f/copyfrom

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	will be ignored	string	Name of the project attribute template
description	will be ignored	string	Description of the project attribute template
id	mandatory	string(guid)	Unique guid of the source project attribute template

Card

label	HttpMethod

PUT

Card

label	Description

Updates the specified target project attribute template with all attribute templates from source project attribute template.
When project attribute template id is missing will be used internally default project attribute template (Guid as "0149c4a8-4e84-4c40-bfdd-5dd63b109266") as a source project attribute template.

Note:
In case when some attribute templates are already assigned to target project attribute template and the same attribute template is present also in source project attribute template,
in such case attribute templates will be added to target project attribute template.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Default",
    "description": "Default project attribute template",
    "id": "0149c4a8-4e84-4c40-bfdd-5dd63b109266"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My project attribute template",
  "description": "Project attribute template for my team",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	createTeamTemplate
	createTeamTemplate

Create an attribute template

Deck of Cards

id	bimCreateTeamTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the attribute template
description	optional	string	Short description of the attribute template
projectAttributeTemplate	mandatory	string(guid)	Guid of the project attribute template
freeattributes	optional	JSON Array	List of free attributes directly under this template ( in create, only IDs of those attributes are required ) The List defines also automatically the orderNumber of the attributes inside of the template
elementtypes	mandatory	JSON Array	List of element type ids to which the template will be assigned. At least one element type is mandatory.
groups	optional	JSON Array	Sub-groups of attributes
created	will be ignored	string ( Date )	Creation date
createdBy	will be ignored	JSON ( User )	User who created the template
changed	will be ignored	string ( Date )	Date of last modification
changedBy	will be ignored	JSON ( User )	User who did the modification
orderNumber	optional	integer	will be used for ordering current attribute template to existing templates 0 -> this template will be added at the end of all templates. 1...n -> this template will be added at a fixed position; all other templates will be reordered automatically

The property "groups" has following JSON structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the group
description	optional	string	Group description
freeattributes	optional	Json Array	List of free attributes directly under this group ( in create, only IDs of those attributes are required )
groups	optional	Json Array	List of subgroups of this group.

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attribute template using free attributes & element types. For both free attributes and element types, it is enough to specify just their IDs in the request, the rest of the data will be loaded automatically from the database, and returned in the response.

Free attributes may be directly under the template, or you could use the "groups" property to create a logical hierarchy of attributes in groups.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My attribute template",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
      "id": "10074EEF-9418-4D64-9C6D-23932835A7F1"
    }
  ],
  "groups": [
    {
      "name": "Group 1",
      "description": "One of the top groups",
      "freeattributes": [
        {
          "id": "06124729-2778-4c16-98d1-9d89e760b195"
        }
      ]
    },
    {
      "name": "Group 2",
      "groups": [
        {
          "name": "SubGroup 3",
          "description": "Some sub group",
          "freeattributes": [
            {
              "id": "665b0658-e64f-4ce2-91b2-c5d152b177d5"
            }
          ]
        }
      ]
    }
  ],
  "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My attribute template",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
      "type": "Wall",
      "category": "/1/10/1/",
      "name": "ID_ArchWall",
      "ifcType": "ID_IFCWallStandardCase",
      "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
    }
  ],
  "groups": [
    {
      "id": "960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
      "name": "Group 1",
      "description": "One of the top groups",
      "freeattributes": [
        {
          "type": "string",
          "decimal": 0,
          "changeable": 0,
          "id": "06124729-2778-4c16-98d1-9d89e760b195",
          "name": "FireRating",
          "description": ""
        }
      ]
    },
    {
      "id": "0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
      "name": "Group 2",
      "groups": [
        {
          "id": "e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
          "name": "SubGroup 3",
          "description": "Some sub group",
          "freeattributes": [
            {
              "type": "int",
              "decimal": 0,
              "changeable": 0,
              "id": "665b0658-e64f-4ce2-91b2-c5d152b177d5",
              "name": "LoadBearing",
              "description": ""
            }
          ]
        }
      ]
    }
  ],
  "created": "2016-02-12T07:21:33.43",
  "createdby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "test@nemetschek.com"
  },
  "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	getTeamTemplates
	getTeamTemplates

Get all the attribute templates that belongs to a team

Deck of Cards

id	bimGetTeamTemplates

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates

Card

label	HTTP Method

GET

Card

label	Description

Get all the attribute templates that belongs to a team.

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": "My attribute template",
    "description": "Attribute template for Walls",
    "elementtypes": [
      {
        "type": "Wall",
        "category": "/1/10/1/",
        "name": "ID_ArchWall",
        "ifcType": "ID_IFCWallStandardCase",
        "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
      }
    ],
    "groups": [
      {
        "id": "960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
        "name": "Group 1",
        "description": "One of the top groups",
        "freeattributes": [
          {
            "type": "string",
            "decimal": 0,
            "changeable": 0,
            "id": "06124729-2778-4c16-98d1-9d89e760b195",
            "name": "FireRating",
            "description": ""
          }
        ]
      },
      {
        "id": "0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
        "name": "Group 2",
        "groups": [
          {
            "id": "e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
            "name": "SubGroup 3",
            "description": "Some sub group",
            "freeattributes": [
              {
                "type": "int",
                "decimal": 0,
                "changeable": 0,
                "id": "665b0658-e64f-4ce2-91b2-c5d152b177d5",
                "name": "LoadBearing",
                "description": ""
              }
            ]
          }
        ]
      }
    ],
    "created": "2016-02-12T07:21:33.43",
    "createdby": {
      "id": "7c555899-5a5f-44d1-930e-284930678bed",
      "email": "test@nemetschek.com"
    },
    "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
    "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
  },
  ...
]

Anchor

	getBimTemplateInfo
	getBimTemplateInfo

Get the info about a particular attribute template

Deck of Cards

id	bimGetBimTemplateInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates/3e5c0964-8f28-469b-b176-bcfad48f2eef

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular attribute template that belongs to a particular team.

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": "My attribute template",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
      "type": "Wall",
      "category": "/1/10/1/",
      "name": "ID_ArchWall",
      "ifcType": "ID_IFCWallStandardCase",
      "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
    }
  ],
  "groups": [
    {
      "id": "960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
      "name": "Group 1",
      "description": "One of the top groups",
      "freeattributes": [
        {
          "type": "string",
          "decimal": 0,
          "changeable": 0,
          "id": "06124729-2778-4c16-98d1-9d89e760b195",
          "name": "FireRating",
          "description": ""
        }
      ]
    },
    {
      "id": "0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
      "name": "Group 2",
      "groups": [
        {
          "id": "e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
          "name": "SubGroup 3",
          "description": "Some sub group",
          "freeattributes": [
            {
              "type": "int",
              "decimal": 0,
              "changeable": 0,
              "id": "665b0658-e64f-4ce2-91b2-c5d152b177d5",
              "name": "LoadBearing",
              "description": ""
            }
          ]
        }
      ]
    }
  ],
  "created": "2016-02-12T07:21:33.43",
  "createdby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "test@nemetschek.com"
  },
  "changed": "2016-02-12T07:22:51.02",
  "changedby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "test@nemetschek.com"
  },
  "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	updateTeamTemplate
	updateTeamTemplate

Update a particular attribute template

Deck of Cards

id	updateTeamTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates/3e5c0964-8f28-469b-b176-bcfad48f2eef

JSON Structure: See Create attribute template

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular attribute template that belongs to a particular team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My attribute template updated",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
      "id": "10074EEF-9418-4D64-9C6D-23932835A7F1"
    }
  ],
  "groups": [
    {
      "name": "Group 1",
      "description": "One of the top groups",
      "freeattributes": [
        {
          "id": "06124729-2778-4c16-98d1-9d89e760b195"
        }
      ]
    },
    {
      "name": "Group 2",
      "groups": [
        {
          "name": "SubGroup 3",
          "description": "Some sub group",
          "freeattributes": [
            {
              "id": "665b0658-e64f-4ce2-91b2-c5d152b177d5"
            }
          ]
        }
      ]
    }
  ],
  "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My attribute template updated",
  "description": "Attribute template for Walls",
  "elementtypes": [
    {
      "type": "Wall",
      "category": "/1/10/1/",
      "name": "ID_ArchWall",
      "ifcType": "ID_IFCWallStandardCase",
      "id": "10074eef-9418-4d64-9c6d-23932835a7f1"
    }
  ],
  "groups": [
    {
      "id": "960005e0-c24b-44c1-a4e7-cc2d7316c1f3",
      "name": "Group 1",
      "description": "One of the top groups",
      "freeattributes": [
        {
          "type": "string",
          "decimal": 0,
          "changeable": 0,
          "id": "06124729-2778-4c16-98d1-9d89e760b195",
          "name": "FireRating",
          "description": ""
        }
      ]
    },
    {
      "id": "0f2ff22f-070d-4bbd-a67d-d2f47f1737ee",
      "name": "Group 2",
      "groups": [
        {
          "id": "e3a56ecd-3c75-40d3-8de7-fdaa1ba2eb4f",
          "name": "SubGroup 3",
          "description": "Some sub group",
          "freeattributes": [
            {
              "type": "int",
              "decimal": 0,
              "changeable": 0,
              "id": "665b0658-e64f-4ce2-91b2-c5d152b177d5",
              "name": "LoadBearing",
              "description": ""
            }
          ]
        }
      ]
    }
  ],
  "created": "2016-02-12T07:21:33.43",
  "createdby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "test@nemetschek.com"
  },
  "changed": "2016-02-12T07:22:51.02",
  "changedby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "test@nemetschek.com"
  },
  "projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	deleteTeamTemplate
	deleteTeamTemplate

Delete a particular attribute template

Deck of Cards

id	bimDeleteTeamTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: attributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/attributetemplates/3e5c0964-8f28-469b-b176-bcfad48f2eef

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the specific attribute template.

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

Anchor

	getElementForTemplate
	getElementForTemplate

Retrieve a list of element-types to which an attribute template can be assigned

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"
    },
.....]

Anchor

	getTemplatesFromElement
	getTemplatesFromElement

Get the list of attribute templates that belongs to an element-type

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": {

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "unit": "kg",
    "contextUnitType": "MASSUNIT",
    "id": "3b871b6571e0ac3b-516efa49-4e7ee540-a35fac2f-faa7501d5d0d8caff3dd72ed",
            "nameemail": "kilogram"jayaraj.purushothaman@gmail.com"
        },
      "description": "updated description"
}

...

Delete a particular unit

...

id	bimDeleteBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the specific unit.

"projectAttributeTemplate": "bb6ccf01-75f1-4581-842a-95bbe71f7285",
        "id": "3f025e20-1c11-42b1-ad3b-0f6cc6fc03af"
    }
]

projectattributetemplate

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

...

label	Response

...

borderColor	Green
title	Status
lang	xml

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 32

New Version Current

Key

Custom attribute Service

Bimplus DB

Delete a particular free attribute

Delete a particular free attribute

Create a new unit in Bimplus DB

Create a new unit in Bimplus DB

Get all the units from Bimplus DB

Get the info about a particular unit in Bimplus DB

Get all the units from Bimplus DB

Get the info about a particular unit in Bimplus DB

Delete a particular unit

Create an attribute template

Update a particular unit

Delete a particular unit

Create new project attribute template in team

Get

the list of existing project attribute templates

in team

Get the info about a particular project attribute template

Update a particular

project attribute template

Delete the project attribute template

Copy attribute templates from source to target project attribute template

Create an attribute template

Get all the attribute templates that belongs to a team

Get the info about a particular attribute template

Update a particular attribute template

Delete a particular attribute template

Retrieve a list of element-types to which an attribute template can be assigned

Get the list of attribute templates that belongs to an element-type

Delete a particular unit