Versions Compared

Old Version 23

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 24

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

Deck of Cards
idbimUpdateVariant
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/variants/<variant_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>projects/<project_id>/variants/<variant_id>

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants/733e429a-e232-4e5d-a41e-9bd50aa9763c

JSON Structure: 

Name

Mandatory / Optional

Type

Description

parentId

optional

string(guid)

Parent node id of the structure (for the first structure, projectId is the parentId)

name

optional

string

Name of the structure variant

description

optional

string

Description of the structure

typeoptionalstringType of the structure (eg: costStructure, specificationStructure)
nroptionalintegerThe index of the structure
coloroptionalintegerColor of the structure

variant

idwill be ignoredstring(guid)Unique guid of the structurevariant
Card
labelHTTP Method
 PUT
Card
labelDescription
 Update the specified structure variant
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "name": "Updated TestVariant4 name"
  "description": "Updated Structuredescription of the TestVariant4"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "parentIdname": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "Updated StructureUpdated TestVariant4 name",
    "description": "FullLifeCycleTest",
Updated description of  "type": "CostStructure",
    "nr": 1the TestVariant4",
    "color": 0,
    "id": "179439d6733e429a-df16e232-41cc4e5d-bd2ca41e-74d05b7995d59bd50aa9763c"
}