Page History

...

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

...

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

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

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

...

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

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

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

...

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:

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

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",
    "name": "kilogram",
    "description": "updated description"
}

...

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

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

Anchor

	updateBimUnitupdateTeamTemplateupdateBimUnit
	updateTeamTemplate

...

Update a particular

...

attribute template

Deck of Cards

id	updateBimUnitupdateTeamTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/units attributetemplates

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	id Id of the unittemplate
namemandatory	will be ignored	string	Name of the unitattribute template
description	optional	string	Short description of the unitattribute template
symbolfreeattributes	mandatoryoptional	stringJSON Array	Symbol of the unit	List of free attribute ids
elementtypesbaseunitid	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

JSON Array

List of element type ids

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular attribute template that belongs to a particular team

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "unitname": "kgAttribute Template 1",
    "contextUnitTypedescription": "MASSUNITupdated description",
    "idelementtypes": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
 [
        {
            "nametype": "kilogramnot implemented",
            "descriptioncategory": "updated description/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"
}

Anchor

	deleteBimUnit
	deleteBimUnit

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 33

New Version 34

Key

Update a particular

attribute template