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

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

...

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",
    "name": "kilogram",
    "description": "base unit for mass"
}

Anchor

	updateBimAttributeGroupupdateBimUnitupdateBimAttributeGroup
	updateBimUnit

Update a particular

...

unit

Deck of Cards

id	bimUpdateBimAttributeGroupupdateBimUnit

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroups units

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

Example: https://api-stage.bimplus.net/v2/content/freeattributegroupsunits/b03b5eb03b871b65-58f0516e-40a74e7e-95fba35f-cb36b6f14cc8faa7501d5d0d

JSON Structure:

will be ignored (guid)

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

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": "b03b5eb03b871b65-58f0516e-40a74e7e-95fba35f-cb36b6f14cc8faa7501d5d0d",
    "name": "Engineering Attributeskilogram",
    "description": "updated description"
}

Anchor

	deleteBimAttributeGroupdeleteBimUnitdeleteBimAttributeGroup
	deleteBimUnit

Delete a particular

...

unit

Deck of Cards

id	bimDeleteBimAttributeGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: content/freeattributegroupsunits

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

Example: https://api-stage.bimplus.net/v2/content/freeattributegroupsunits/b03b5eb03b871b65-58f0516e-40a74e7e-95fba35f-cb36b6f14cc8faa7501d5d0d

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified attribute groupthe 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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 28

New Version 29

Key

Team DB

Update a particular

unit

Delete a particular

unit