Versions Compared

Old Version 43

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 44

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

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 of unit: 

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the unit

description

optional

string

Short description of the unit

symbolunitmandatorystringSymbol of the unit
contexUnitTypeoptionalstringContext unit type
baseunitsoptionalarray of jsonsList of base units

 

The "baseunits" property is an array of jsons with following definitions :

NameMandatory/OptionalTypeDescription
baseunitidoptionalstring(guid)Specify this property for deriving a unit from a base unitBase unit ID
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
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "name": "MyDerivedUnit",
  "description": "Example of derived unit",
  "symbol": "Sym",
  "baseunits" : [
      {
            "baseunitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
            "usequence": 1,
            "ufactor": 2,
            "upower": 3
}
      }
  ]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
  "symbolid": "Sym9c75f2e7-bf66-4274-96a6-fb61ecb0e21a",
  "baseunitidname": "3b871b65-516e-4e7e-a35f-faa7501d5d0dMyDerivedUnit",
  "usequencedescription": 1 "Example of derived unit",
  "ufactorsymbol": 2.0"Sym",
  "upowerbaseunits" : 3,
  "id [
      {
            "baseunitid": "9c75f2e73b871b65-bf66516e-42744e7e-96a6a35f-fb61ecb0e21afaa7501d5d0d",
            "nameusequence": 1,
            "MyDerivedUnitufactor": 2,
            "descriptionupower": "Example of derived unit" 3
      }
  ]
}

Anchor
getBimUnitList
getBimUnitList

...