Versions Compared

Old Version 15

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 16

changes.mady.by.user Ivan Pavlovcik

Saved on

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
idbimcreateVariant
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/variants 

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/variants

JSON Structure: 

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the variant

description

optional

string

Description of the variant

idwill be ignoredstring(guid)Unique guid of the structure


Card
labelHTTP Method
 POST
Card
labelDescription
 Create a new variant of defined structure(eg: cost structure, specification structure) under a project
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "name": "TestVariant",
    "description": "Description of the Test variant"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
  "name": "TestVariant",
  "description": "Description of the Test variant",
  "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}

 

Anchor
getVariantDetails
getVariantDetails

Get the variant details
Deck of Cards
idbimGetVariantDetails
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 

Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of 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
Code Block
borderColorRed
langxml
titleJSON
{
  "name": "TestVariant",
  "description": "Description of the Test variant",
  "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}