Versions Compared

Key

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

...

Deck of Cards
idbimGetStructureTopology
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: structures/<structure_id>/topology 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/topology

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/topology

Card
labelDescription
 Get details of a specified structure.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "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

Assign an object to the latest/last structure node
Deck of Cards
idbimassignStructure
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: structures/<structure_id>/assign/<object_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/assign/<object_id> 

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f

JSON Structure

Name

Mandatory / Optional

Type

Description

structureId

will be ignored

string(guid)

The id of the last node to which an object will be assigned

objectId

will be ignored

string(guid)

The id of the object to whom a structure will be assigned

name

mandatory

string

The name of the structure-object connection

nroptionalintegerThe index of the structure-object connection
idwill be ignoredstring(guid)Unique guid of the structure-object connection


Card
labelDescription
 Assign an object to the latest/last structure node
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
  "name": "WallConnection"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
    "objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
    "name": "WallConnection",
    "nr": 1,
    "id": "35b986c2-e9cd-482e-9281-6000671a49f0"
}

 

Anchor
authorizationService
authorizationService

...