Versions Compared

Key

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

...

Deck of Cards
idbimassignStructure
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

structureIdcolor

will be ignoredoptional

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

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


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

...

Deck of Cards
idbimCopyStructure
Card
labelUrl / Resource /Json

Resource: structures/<structure_id>/copy

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

Example: https://api-stage.bimplus.net/v2/bimplus/structures/35b986c2-e9cd-482e-9281-6000671a49f0/copy

 

JSON Structure

 

Name

Mandatory / Optional

Type

Description

 

 

string(guid)

 

 Parent node id of the structure (for the first structure, projectId is the parentId)

name

mandatory

string

Name of the new structure

description 

optional 

string

 

 Description of the structure

typeoptionalstringType of the new structure (eg: costStructure, specificationStructure)
nrwill be ignoredintegerThe index of the new structure
coloroptionalintegerColor of the new structure
idwill be ignoredstring(guid)Unique guid of the structure
startDateoptionalstring (date)Start date ( depends on type of structure )
endDateoptionalstring (date)End date ( depends on type of structure )

 

Card
labelHttpMethod

POST

...