Versions Compared

Old Version 16

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 17

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
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"
}

Anchor
getVariantList
getVariantList

Get the list of existing variants inside a project
Deck of Cards
idbimGetVariantList
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 

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the list of existing variants inside a project.
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": "TestVariant1",
    "description": "Description of the Test variant 1",
    "id": "6dc03014-8601-49fd-bae9-ef5b185603b6"
  },
  {
    "name": "TestVariant2",
    "description": "Description of the Test variant 2",
    "id": "4c1fda6b-7fd9-42a7-a4ae-88eababd3082"
  },
  {
    "name": "TestVariant3",
    "description": "Description of the Test variant 3",
    "id": "f2cf9b21-c1bb-463d-bbee-a6fbfb5e8b3e"
  },
  {
    "name": "TestVariant4",
    "description": "Description of the Test variant 4",
    "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
  }
]