Versions Compared

Key

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

...

Structure Service

...

A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service

...

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

URLhttps://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

name

optional

string

Name of the variant

description

optional

string

Description of the variant

idwill be ignoredstring(guid)Unique guid of the variant
Card
labelHTTP Method
 PUT
Card
labelDescription
 Update the specified 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 description of the TestVariant4"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "name": "Updated TestVariant4 name",
    "description": "Updated description of the TestVariant4",
    "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}

Anchor
deleteVariant
deleteVariant

Delete the structure
Deck of Cards
idbimDeleteVariant
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/variants/<variant_id> 

URLhttps://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

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