View Source

Custom attribute Service

Bimplus DB

Team 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.

Attribute Templates

Element-type filter

Custom attribute Service

Using these services, custom property groups & its associated properties can be created.

Create a new custom group in Bimplus DB

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

POST

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)

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

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

Status: 201 Created

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

Get all the free attribute groups from the Bimplus DB

Resource: content/freeattributegroups

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

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

GET

Get all the free attribute groups from the Bimplus DB

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

Status: 200 OK

 [
    {
        "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": ""
    }
]

Get the info about a particular free attribute group

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

GET

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

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

Status: 200 OK

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

Update a particular free attribute group

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

PUT

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

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

{
    "description": "updated description"
}

Status: 200 OK

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

Delete a particular free attribute group

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

DELETE

Deletes a specified attribute group.

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

Status: 200 OK

Create a free attribute under a particular attribute group or as stand-alone

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"
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")
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.

POST

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)

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

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

Status: 201 Created

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

Get all the free attributes from the Bimplus DB

Resource: content/freeattributes

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

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

GET

Get all the free attributes from the Bimplus DB

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

Status: 200 OK

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

Get all the free attributes under a attribute group

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

GET

Get all the free attributes under a attribute group

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

Status: 200 OK

 [
    {
        "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@"
    }
]

Get the info about a particular free attribute in Bimplus DB

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

GET

Get the info about a particular free attribute in Bimplus DB

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

Status: 200 OK

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

Update a particular free attribute in Bimplus DB

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	optional	string	Name of the attribute
description	optional	string	Short description of the attribute
type	optional	string	Type of free attributes. It could be one of the following: "int", "double", "string", "guid", "datetime", "binary"
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")
symbol	will be ignored	string	Symbol of the unit
parent	optional	string(guid)	Id of the attribute group. It is also possible to move attribute to another group by changing its parent

PUT

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

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

{
    "description": "updated description"
}

Status: 200 OK

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

Delete a particular free attribute

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

DELETE

Deletes a specific attribute.

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

Status: 200 OK

Create a new unit in Bimplus DB

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)

POST

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

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

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

Status: 201 Created

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

Get all the units from Bimplus DB

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.

GET

Get all the units from Bimplus DB.

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

Status: 200 OK

[
    {
        "unit": "kg",
        "contextUnitType": "MASSUNIT",
        "id": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
        "name": "kilogram",
        "description": "base unit for mass"
    },
    {
        "unit": "m",
        "contextUnitType": "LENGTHUNIT",
        "id": "7be3452a-47f9-4fd8-bd94-ef6c967d684e",
        "name": "meter",
        "description": "base unit for length"
    },
    {
        "unit": "s",
        "contextUnitType": "TIMEUNIT",
        "id": "456e899b-2bda-49a5-8e6f-e1ff8bfd9e14",
        "name": "second",
        "description": "base unit for time"
    },
    {
        "unit": "K",
        "contextUnitType": "THERMODYNAMICTEMPERATUREUNIT",
        "id": "cbd91636-49fa-4a4f-bdcc-03f27ca205f8",
        "name": "kelvin",
        "description": "base unit for thermodynamic temperature"
    },
......
]

Get the info about a particular unit in Bimplus DB

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

GET

Get the info about a particular unit in Bimplus DB.

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

Status: 200 OK

{
    "unit": "kg",
    "contextUnitType": "MASSUNIT",
    "id": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
    "name": "kilogram",
    "description": "base unit for mass"
}

Update a particular unit

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:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	id of the unit
name	optional	string	Name of the unit
description	optional	string	Short description of the unit
symbol	optional	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)

PUT

Update a particular unit.

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

{
    "description": "updated description"
}

Status: 200 OK

{
    "unit": "kg",
    "contextUnitType": "MASSUNIT",
    "id": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
    "name": "kilogram",
    "description": "updated description"
}

Delete a particular unit

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

Deletes the specific unit.

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

Status: 200 OK

Create an attribute template

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	List of element type ids

POST

Creates a new attribute template using free attributes & element types.

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

{
  "name": "Attribute Template 1",
  "description": "Testing template",
  "freeattributes": [
    {
      "Id": "5EED7275-0B0D-41D5-A13E-0C1C1FA87B33"
    },
    {
      "Id": "67900FFF-A744-4EA3-A0DC-4140E424B756"
    },
    {
      "Id": "B5850E23-B1DF-4D4F-AAE8-CEE0D4BB06E6"
    }
  ],
  "elementtypes": [
    {
      "id": "F18DE608-0F7F-40E3-A0F7-8088778D18CB"
    },
    {
      "id": "F8E1D9E3-82C0-4F14-8337-7FE568117616"
    }
  ]
}

Status: 201 Created

{
  "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",
      "category": "/",
      "name": "ID_Hall",
      "ifcType": null,
      "id": "f18de608-0f7f-40e3-a0f7-8088778d18cb"
    }
  ],
  "freeattributes": [
    {
      "type": "double",
      "minvalue": "0",
      "decimal": 2,
      "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
      "unit": "mm",
      "visible": 1,
      "changeable": 1,
      "controltype": "TextBox",
      "id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
      "name": "bend radius",
      "description": "bend diameter for reinforcement bars"
    },
    {
      "type": "double",
      "decimal": 2,
      "unitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
      "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",
      "description": "Test attribute"
    }
  ],
  "created": "2015-04-23T05:42:52.91",
  "createdby": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "sslacky@nemetschek.com"
  },
  "id": "3e5c0964-8f28-469b-b176-bcfad48f2eef"
}

Get all the attribute templates that belongs to a team

Resource: attributetemplates

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

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

GET

Get all the attribute templates that belongs to a team.

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

Status: 200 OK

[
    {
        "name": "Template 1",
        "created": "2015-10-27T09:22:13.27",
        "createdby": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "changed": "2015-10-27T09:32:05.27",
        "changedby": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "id": "511f1724-3848-49a2-8b21-77180b61edc0"
    }
]

Get the info about a particular attribute template

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

GET

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

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

Status: 200 OK

{
    "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",
            "category": "/",
            "name": "ID_Hall",
            "ifcType": null,
            "id": "f18de608-0f7f-40e3-a0f7-8088778d18cb"
        }
    ],
    "freeattributes": [
        {
            "type": "double",
            "minvalue": "0",
            "decimal": 2,
            "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
            "unit": "mm",
            "visible": 1,
            "changeable": 1,
            "controltype": "TextBox",
            "id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
            "name": "bend radius",
            "description": "bend diameter for reinforcement bars"
        },
        {
            "type": "double",
            "decimal": 2,
            "unitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
            "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",
            "description": "Test attribute"
        }
    ],
    "created": "2015-04-23T05:42:52.91",
    "createdby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschek.com"
    },
    "changed": "2015-04-23T05:42:52.91",
    "changedby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschek.com"
    },
    "id": "3e5c0964-8f28-469b-b176-bcfad48f2eef"
}

Update a particular attribute template

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:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	Id of the template
name	will be ignored	string	Name of the attribute template
description	optional	string	Short description of the attribute template
freeattributes	optional	JSON Array	List of free attribute ids
elementtypes	optional	JSON Array	List of element type ids

PUT

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

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

{
    "description": "updated description"
}

Status: 200 OK

{
    "name": "Attribute Template 1",
    "description": "updated description",
    "elementtypes": [
        {
            "type": "not implemented",
            "category": "/7/1/10/",
            "name": "ID_Wandobjekte",
            "ifcType": "ID_IFCWall",
            "id": "f8e1d9e3-82c0-4f14-8337-7fe568117616"
        },
        {
            "type": "not implemented",
            "category": "/",
            "name": "ID_Hall",
            "ifcType": null,
            "id": "f18de608-0f7f-40e3-a0f7-8088778d18cb"
        }
    ],
    "freeattributes": [
        {
            "type": "double",
            "minvalue": "0",
            "decimal": 2,
            "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
            "unit": "mm",
            "visible": 1,
            "changeable": 1,
            "controltype": "TextBox",
            "id": "b5850e23-b1df-4d4f-aae8-cee0d4bb06e6",
            "name": "bend radius",
            "description": "bend diameter for reinforcement bars"
        },
        {
            "type": "double",
            "decimal": 2,
            "unitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
            "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",
            "description": "Test attribute"
        }
    ],
    "created": "2015-04-23T05:42:52.91",
    "createdby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschek.com"
    },
    "changed": "2015-04-23T05:42:52.91",
    "changedby": {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email": "sslacky@nemetschek.com"
    },
    "id": "3e5c0964-8f28-469b-b176-bcfad48f2eef"
}

Delete a particular attribute template

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

DELETE

Deletes the specific attribute template.

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

Status: 200 OK

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

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

GET

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)

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

Status: 200 OK

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

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

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

Filter: The default API doesn't include the free attribute list in the response. To include the free attribute list, please use the filter ?attributes=true. eg: https://api-stage.bimplus.net/v2/bimplus/element-types/10074eef-9418-4d64-9c6d-23932835a7f1/attributetemplates?attributes=true

GET

Get all the free attribute groups from the Bimplus DB

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

Status: 200 OK

 [
    {
        "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"
        },
        "id": "3f025e20-1c11-42b1-ad3b-0f6cc6fc03af"
    }
]