Versions Compared

Key

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

...

Deck of Cards
idbimUpdateBimAttribute
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/freeattributes

URLhttps://api-stage.bimplus.net/v2/content/freeattributes/<attribute_id>

Example: https://api-stage.bimplus.net/v2/content/freeattributes/c4623c1b-dfd3-4117-af37-091eaaff60bf

JSON Structure

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring(guid)Id of the free attribute

name

optional

string

Name of the attribute

description

optional

string

Short description of the attribute

type

optional

string

Type of free attributes. It could be one of the following: "int", "double", "string", "guid", "datetime", "binary"
minvalueoptionalstring(numbers)Minimum value constraint of the attribute
maxvalueoptionalstring(numbers)Maximum value constraint of the attribute
defaultvalueoptionalstring(numbers)Default value of the attribute (if it's value is not specified)
decimaloptionalintNumber of decimals
unitidoptionalstring(guid)Id of the unit
optionalsymboloptionalstring(symbol)Optional symbol
visibleoptionalint0 or 1. It determines whether the attribute should be visible
changeableoptionalint0 or 1. It determines whether the attribute should be chnageable
controltypeoptionalstringThe control type (eg: "textbox")
symbolwill be ignoredstringSymbol of the unit
parentoptionalstring(guid)Id of the attribute group. It is also possible to move attribute to another group by changing its parent
Card
labelHTTP Method
 PUT
Card
labelDescription
 Update a particular free attribute. It is also possible to move attribute to another group by changing its parent.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "type": "double",
    "minvalue": "0",
    "defaultvalue": "5",
    "decimal": 2,
    "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
    "unit": "mm",
    "visible": 1,
    "changeable": 0,
    "controltype": "TextBox",
    "name": "concrete cover",
    "description": "updated description"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "type": "double",
    "minvalue": "0",
    "defaultvalue": "5",
    "decimal": 2,
    "unitid": "f99f40cf-da64-4c4f-8434-cb90722ba485",
    "unit": "mm",
    "visible": 1,
    "changeable": 0,
    "controltype": "TextBox",
    "id": "c4623c1b-dfd3-4117-af37-091eaaff60bf",
    "name": "concrete cover",
    "description": "updated description"
}

...