Versions Compared

Old Version 25

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 26

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Deck of Cards
idbimDeleteBimAttribute
Card
defaulttrue
labelURL / Resource / JSON Structure
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

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specific attribute.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
createBimUnit
createBimUnit

Create a new unit in Bimplus DB
Deck of Cards
idbimcreateBimUnit
Card
defaulttrue
labelURL / 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

symbolmandatorystringSymbol of the unit
baseunitidoptionalstring(guid)Specify this property for deriving a unit from a base unit
usequenceoptionalintUnit sequence (default is 1)
upoweroptionalintUnit power (default is 1)

ufactor

optional

int

Unit factor (default is 1)

Card
labelHTTP Method
 POST
Card
labelDescription
 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
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
  "name": "MyDerivedUnit",
  "description": "Example of derived unit",
  "symbol": "Sym",
  "baseunitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
  "usequence": 1,
  "ufactor": 2,
  "upower": 3
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
  "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"
}