Page History

...

Section

Column

Project Service

Column

Model Service

Column

Object Service

...

Section

Column

width	25%

Import Service

Replace a model by importing SketchUp and IFC files

Column

width	25%

Slideshow Service

Column

width	25%

Hyperlink Service

Column

width	25%

Structure Service

Section

Column

width	25%

Authorization Service

Column

width	25%

User Management Service

Column

width	25%

Team Management Service

Column

width	25%

Membership Management Service

...

Deck of Cards

id	bimGetProjectDisc

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: thumbnail/<thumbnail_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Card

label	Description

Downloads the thumbnail.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	deleteProjectgetStructureListdeleteProject
	getStructureList

...

Get the structure list from a project

Deck of Cards

id	bimDeleteProjectbimGetStructureDetails

Card

label	HTTP Method

DELETE GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectsstructures/<project<structure_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc179439d6-3588df16-45d641cc-a59abd2c-f6b89ebed34e74d05b7995d5/structures

Card

label	Description

Deletes Get the structure list from a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Code Block

...

borderColor

...

Red

...

title

Model Service

A Model is basically a technical building plan which could be created or imported.

...

JSON
lang	xml

[
    {
        "name": "TestStructure",
        "description": "FullLifeCycleTest",
        "type": "CostStructure",
        "nr": 1,
        "color": 0,
        "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
    },
    {
        "name": "TestStructure2",
        "description": "Another Structure",
        "type": "SpecificationStructure",
        "nr": 2,
        "color": 0,
        "id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
    }
]

Anchor

	deleteStructure
	deleteStructure

Delete all the structures from a project

Deck of Cards

id	bimDeleteStructureList

...

Create a new model

Deck of Cards

id	bimCreateModel

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Example: https://api-stage.bimplus.net/v2/bimplus/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the model
description	optional	string	Short description of the model
projectId	will be ignored	string (guid)	Id of the project to which the model belongs
topologyId	optional	string (guid)	Id of the topology to which the model belongs
disciplines	optional	object	The discipline list of the model

Card

label	Description

Creates a new model.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "name":"Model D", 
 "description":"Creating a model via API"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "Model D",
    "description": "Creating a model via API",
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "id": "afbb314f-fdde-43e7-9a49-90e16c1a6131"
}

...

Get the list of existing models inside a project

Deck of Cards

id	bimGetModelList

Card

label	HTTP Method

GET DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions projects/<project_id>/structures

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/divisionsstructures

Example: https://api-stage.bimplus.net/v2/bimplus-gmbh/projects/743a24f9db540336-baaa47a3-41b9426e-90b3b3bf-91717238043c1e532bfac8ea/divisionsstructures

Card

label	Description

Gets the list of existing models inside a project. Deletes all the structures from a specified project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

...

	deleteProject

...

	deleteProject

...

Delete the project

titleJSONlang

Deck of Cards

id

bimDeleteProject

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Card

label	Description

Deletes a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	modelService
	modelService

Model Service

...

A Model is basically a technical building plan which could be created or imported.

Anchor

	createModel
	createModel

Create a new model

Deck of Cards

id	bimCreateModel

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Example: https://api-stage.bimplus.net/v2/bimplus/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the model
description	optional	string	Short description of the model
projectId	will be ignored	string (guid)	Id of the project to which the model belongs
topologyId	optional	string (guid)	Id of the topology to which the model belongs
disciplines	optional	object	The discipline list of the model

Card

label	Description

Creates a new model.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "name":"Model D", 
 "description":"Creating a model via API"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "Model D",
    "description": "Creating a model via API",
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "id": "afbb314f-fdde-43e7-9a49-90e16c1a6131"
}

Anchor

	getModelList
	getModelList

Get the list of existing models inside a project

Deck of Cards

id	bimGetModelList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Example: https://api-stage.bimplus.net/v2/bimplus-gmbh/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

Card

label	Description

Gets the list of existing models inside a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

xml

[
    {
        "name": "Model A - Vogel",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "fc4be8b1-bf85-4c6f-b9c2-bac6474ddb1d",
        "id": "d81494b9-9731-4d2e-8fbe-da62f5270182"
    },
    {
        "name": "Model B - house sketchup",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "2d20d707-9c18-44c0-92f4-282948cd5cf5",
        "id": "deec1913-2c6e-4580-a40f-7e1ad33a6300"
    },
    {
        "name": "Model C - Nemetschek",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
        "id": "e687b45b-d90d-4361-94ab-baf269588c0a"
    }
]

...

Deck of Cards

id	bimcreateSubStructure

Card

label	HTTP Method

POST

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	mandatory	string(guid)	Parent node id of the structure (the id specified in the resource url)
name	mandatory	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	will be ignored	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	Description

Create a sub-node under a particular structure

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "Node 1"
}

Card

label	Response

...

Get the structure topology

Deck of Cards

id	bimGetStructureTopology

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>/topology

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

label	Description

Get details of a specified structure.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parentId": "179439d6-df16-41cc-bd2c-74d05b7995d5",
    "name": "Node 1",
    "type": "TopologyStructure",
    "nr": 1,
    "color": 0,
    "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}

...

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parentparentId": null,
    "name": "TestStructure",
    "type": "Structure",
    "children": [
        {
            "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
            "name": "Node 1",
            "type": "StructureTopologyStructure",
    "nr": 1,
       "childrencolor": []0,
            "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
        }
    ],
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Anchor

	assignStructuregetStructureTopology	assignStructure

...

	getStructureTopology

Get the structure topology

Deck of Cards

id	bimassignStructurebimGetStructureTopology

Card

label	HTTP Method

POST GET

Resource: structures/<structure_id>/assign/<object_id>

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

Card

default	true
label	URL / Resource / 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
nr	will be ignored	integer	The index of the structure-object connection
id	will be ignored	string(guid)	Unique guid of the structure-object connection

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>/topology

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

label	Description

Get details of a specified structure.

Card

label	Description

Assign an object to the latest/last structure node

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "WallConnection"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201200 CreatedOK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parent": null,
    "name": "TestStructure",
    "structureIdtype": "adf506ae-3628-4501-9af1-22bcf27e4ab4Structure",
    "objectIdchildren": [
        {
            "parent": "df4a81d6179439d6-42fbdf16-418741cc-bbcebd2c-82a2fc093b2f74d05b7995d5",
            "name": "Node 1",
            "type": "WallConnection",
Structure",
            "children": [],
            "nrid": 1 "adf506ae-3628-4501-9af1-22bcf27e4ab4"
        }
    ],
    "id": "35b986c2179439d6-e9cddf16-482e41cc-9281bd2c-6000671a49f074d05b7995d5"
}

Anchor

	updateStructureassignStructure	updateStructure

...

	assignStructure

Assign an object to the latest/last structure node

Deck of Cards

id	bimUpdateStructurebimassignStructure

Card

label	HTTP Method

PUT POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>/<structure_id>/assign/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id> _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
parentIdstructureIdoptional	will be ignored	string(guid)Parent node	The 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)
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
nr	will be ignored	nr	optional	integer	The index of the structure
color	optional	integer	Color of the structure
-object connection
id	will be ignored	string(guid)	Unique guid of the structure-object connection

Card

label	Description

Update the specified structure Assign an object to the latest/last structure node

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "Updated StructureWallConnection"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200201 OKCreated

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parentIdstructureId": "622272daadf506ae-f1ff3628-45ab4501-a3f09af1-c8f1255c80e822bcf27e4ab4",
    "nameobjectId": "Updated Structuredf4a81d6-42fb-4187-bbce-82a2fc093b2f",
    "descriptionname": "FullLifeCycleTest",
    "type": "CostStructureWallConnection",
    "nr": 1,
    "color": 0,
    "id": "179439d635b986c2-df16e9cd-41cc482e-bd2c9281-74d05b7995d56000671a49f0"
}

Anchor

	deleteStructureupdateStructuredeleteStructure
	updateStructure

...

Update the structure

Deck of Cards

id	bimDeleteStructurebimUpdateStructure

Card

label	HTTP Method

DELETE PUT

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>id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/db540336179439d6-47a3df16-426e41cc-b3bfbd2c-1e532bfac8ea

Card

label	Description

Deletes a specified structure.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

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	Description

Update the specified structure

...

Get the structure list from a project

Deck of Cards

id	bimGetStructureDetails

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>

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

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

Card

label	Description

Get the structure list from a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "Updated Structure"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "nameparentId": "TestStructure",
        "description": "FullLifeCycleTest",
        "type": "CostStructure",
        "nr": 1,
        "color": 0,
        "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
    },
    {
    622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "TestStructure2Updated Structure",
        "description": "Another StructureFullLifeCycleTest",
        "type": "SpecificationStructureCostStructure",
        "nr": 21,
        "color": 0,
        "id": "279439d6179439d6-df16-41cc-bd2c-74d05b7995d5"
    }
]

Anchor

	deleteStructure
	deleteStructure

Delete

...

the

...

structure

Deck of Cards

id	bimDeleteStructureListbimDeleteStructure

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectsstructures/<project<structure_id>/structuresid>

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

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

Card

label	Description

Deletes all the structures from a specified projectstructure.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 483

New Version 484

Key

Project Service

Model Service

Object Service

Import Service

Slideshow Service

Hyperlink Service

Structure Service

Authorization Service

User Management Service

Team Management Service

Membership Management Service

Get the structure list from a project

Model Service

Delete all the structures from a project

Create a new model

Get the list of existing models inside a project

Delete the project

Model Service

Create a new model

Get the list of existing models inside a project

Get the structure topology

Get the structure topology

Assign an object to the latest/last structure node

Update the structure

Get the structure list from a project

Delete

the

structure