Page History

...

Assign additional objects to the latest structureElement node

...

Update the structure

URL / Resource / JSON Structure

Deck of Cards

id	bimUpdateStructure

Card

default

true

label

bimAssignAdditionalObjects

Resource: structures/

<structure

<structureElement_id>/assign/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures

/<structure

/<structureElement_id>/assign/<object_id>

Example: https://api-stage.bimplus.net/v2/bimplus/structures/

179439d6

35b986c2-

df16

e9cd-

41cc

482e-

bd2c-74d05b7995d5

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	optional	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	optional	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	optional	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified structure

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "Updated Structure"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "Updated Structure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

...

9281-6000671a49f0/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f

use the response from previous call for 'StructureElement.id'

Card

label	HttpMethod

POST

Card

label	assignRespons

is the same like previous call

Anchor

	removeAssignedObject
	removeAssignedObject

Remove assigned object from the latest structureElement node

Deck of Cards

id	bimRemoveAssignedObject

Resource: structures/<structureElement_id>/delete/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structureElement_id>/delete/<object_id>

Example: https://api-stage.bimplus.net/v2/bimplus/structures/35b986c2-e9cd-482e-9281-6000671a49f0/delete/df4a81d6-42fb-4187-bbce-82a2fc093b2f

Card

label	HttpMethod

DELETE

Card

label	response

HttpStatusCode.OK

Anchor

	copyStructure
	copyStructure

Copy Structure

Deck of Cards

id	bimCopyStructure

Resource: structures/<structure_id>/copy

URL: https://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

Anchor

	updateStructure
	updateStructure

Update the structure

Deck of Cards

id	bimUpdateStructure

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	optional	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	optional	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	optional	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified structure

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "Updated Structure"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "Updated Structure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Anchor

	deleteStructure
	deleteStructure

Delete the structure

Deck of Cards

id	bimDeleteStructure

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified structure.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Delete the structure

...

Status: 200 OK

bd2c-74d05b7995d5

JSON Structure:

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id> id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_

id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/

db540336

179439d6-

47a3

df16-

426e

41cc-

b3bf-1e532bfac8ea

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified structure.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Name	Mandatory / Optional	Type	Description
parentId	optional	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	optional	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	optional	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 6

New Version 7

Key

Assign additional objects to the latest structureElement node

Update the structure

Remove assigned object from the latest structureElement node

Copy Structure

Update the structure

Delete the structure

Delete the structure