Page History

...

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

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

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getBimUnitList
	getBimUnitList

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

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

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

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

	updateBimAttributeGroup
	updateBimAttributeGroup

Update a particular free attribute group

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

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 26

New Version 27

Key

Get all the units from Bimplus DB

Get the info about a particular unit in Bimplus DB

Update a particular free attribute group

Delete a particular free attribute group