Page History

...

Team DB

Create a free attribute group
Get the info about a particular free attribute group
Update a particular free attribute group
Delete a particular free attribute group
Create a free attribute under a particular attribute group or as stand-alone
Get the info about a particular free attribute
Update a particular free attribute

...

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

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

Anchor

	updateBimAttribute
	updateBimAttribute

Update a particular free attribute in Bimplus DB

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

Anchor

	deleteBimAttributeGroup
	deleteBimAttributeGroup

Delete a particular free attribute group

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 20

New Version 21

Key

Team DB

Update a particular free attribute in Bimplus DB

Delete a particular free attribute group