Versions Compared

Old Version 38

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 39

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

...

Deck of Cards
idbimGetStructureTopology
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: structures/<structure_id>/topology?varianttype=<varianttype_id> 

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/topology?varianttype=<varianttype_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/topology?varianttype=733e429a-e232-4e5d-a41e-9bd50aa9763c

Optional query parameters

NameTypeDefault valueDescription
varianttypestring (guid)Guid.Emptyid of the variant type


Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of a specified structure.
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
{
    "parent": null,
    "name": "TestStructure",
    "type": "Structure",
    "children": [
        {
            "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
            "name": "Node 1",
            "type": "Structure",
            "children": [],
            "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
        }
    ],
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Anchor
putReorderStructure
putReorderStructure

Reorder the structure
Deck of Cards
idbimGetStructureTopology
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: structures/<structure_id>/reorder?varianttype=<varianttype_id> 

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/reorder?varianttype=<varianttype_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/reorder?varianttype=733e429a-e232-4e5d-a41e-9bd50aa9763c

Optional query parameters

NameTypeDefault valueDescription
varianttypestring (guid)Guid.Emptyid of the variant type


Card
labelHTTP Method
 PUT
Card
labelDescription
 Reorder the structure for specified variant type.
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
{
    "parent": null,
    "name": "TestStructure",
    "type": "Structure",
    "children": [
        {
            "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
            "name": "Node 1",
            "type": "Structure",
            "children": [],
            "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
        }
    ],
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

 

Anchor
assignStructure
assignStructure

...