Versions Compared

Old Version 46

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 47

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

Deck of Cards
idbimGetBimUnit
Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
Card
labelDescription
 Get the info about a particular unit in Bimplus DB.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "unit": "kgmm",
    "contextUnitType": "LENGTHUNIT",
    "baseunits": [
      {
        "baseunitid": "MASSUNIT"7be3452a-47f9-4fd8-bd94-ef6c967d684e",
        "usequence": 1,
        "ufactor": 0.001,
        "upower": 1
      }
    ],
    "id": "3b871b65f99f40cf-516eda64-4e7e4c4f-a35f8434-faa7501d5d0dcb90722ba485",
    "name": "kilogrammm",
    "description": "base unit for mass"
 length in millimeter"
  }

Anchor
updateBimUnit
updateBimUnit

...

Deck of Cards
idupdateBimUnit
Unit factor (default is 1)

 See Create Unit

Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/units

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

Example: https://api-stage.bimplus.net/v2/content/units/3b871b65-516e-4e7e-a35f-faa7501d5d0d

JSON Structure: 

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring(guid)id of the unit

name

optional

string

Name of the unit

description

optional

string

Short description of the unit

symboloptionalstringSymbol 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

Card
labelHTTP Method
 PUT
Card
labelDescription
 Update a particular unit.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "name": "MyDerivedUnit updated",
  "description": "Example of derived unit",
  "symbol": "Sym",
  "baseunits" : [
      {
            "baseunitid": "updated description"3b871b65-516e-4e7e-a35f-faa7501d5d0d",
            "usequence": 1,
            "ufactor": 2,
            "upower": 3
      }
  ]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
  "id": "9c75f2e7-bf66-4274-96a6-fb61ecb0e21a",
  "unitname": "kgMyDerivedUnit updated",
  "description": "Example of derived "contextUnitTypeunit",
  "symbol": "MASSUNITSym",
  "baseunits" : [
      {
    "id        "baseunitid": "3b871b65-516e-4e7e-a35f-faa7501d5d0d",
    "name": "kilogram",
        "usequence": 1,
            "ufactor": 2,
            "descriptionupower": "updated description" 3
      }
  ]
}

Anchor
deleteBimUnit
deleteBimUnit

...