Note
Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.

Composition Setup

Info

Developers please

This web page is under construction. The JSON Request and Reply (Request and Reply tab) for the API calls are not complete.

Note

Please use

Newwindowlink

title	httphttps://bimplusapi-devstage.mantrobimplus.net/v2
url	httphttps://bimplusapi-devstage.mantrobimplus.net

for the testing purposes because our productive server

/v2

(stage version of Bimplus API) and

Newwindowlink

title	httpshttp://apiportal-stage.bimplus.net/
url	httpshttp://apiportal-stage.bimplus.net

is not available to the market yet.

Bim+ Services

...

Project Service

...

Create a new project
Get the project list
Get the properties of the project
Update the project
Create an issue in the project
Get the issue list from the project
Delete all the issues from the project
Create a new attachment in the project
Get the attachment list from the project
Delete all the attachments from the project
Get the project disciplines
Delete the project

...

Create a new project

...

id	bimCreateProject

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	date	Creation date of the project

Card

label	Description

Creates a new project.

...

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" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON


{
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

Get the Project List

...

id	bimGetProjectList

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Gets the available project list with main properties.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON


[
    {
        "id": "586b02be-43b8-4e27-b698-e067e85e38e2",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "shortDescr": "Hey, i am your favourite test entry",
        "thumbnail": null,
        "created": "2013-05-01T09:33:18",
        "changed": "2013-05-01T09:33:18"
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": null,
        "created": "0001-01-01T00:00:00",
        "changed": "0001-01-01T00:00:00"
    },
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": null,
        "thumbnail": null,
        "created": "2013-05-10T07:13:38",
        "changed": "2013-05-16T07:34:56"
    }
]

...

Get the Project Properties

...

id	bimGetProjectProp

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Get all the project properties of a project using its id.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON


{
    "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
    "shortDescr": "Hey, i am your favourite test entry",
    "thumbnail": null,
    "created": null,
    "changed": null,
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "63b069d2-81df-4418-91de-8a954fa12924",
            "name": "ID_DesignModel_Timber",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
            "name": "ID_FinishModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
            "name": "ID_RoomModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}

/

(stage version of Shop/Portal) for testing purposes. The production version of the portal is located under

Newwindowlink

title	https://portal.bimplus.net/
url	https://portal.bimplus.net/

and the base url of the API is different for the production version.

Section

border	true

Column

Project relevant services

Column

Administration relevant services

Column

Other services

Section

Column

Project Service

Column

Model Service

Column

Object Service

Section

Column

Custom attribute Service

Column

Revision Service

Column

CustomTable Service

Section

Column

Cross Section Service

Column

Connection Service

Section

Column

ElementType Service

Column

Attachment Service

Column

Issue Service

Column

Pin Service

Section

Column

width	25%

BCF Service

Column

width	25%

Import Service

Replace a model by importing SketchUp and IFC files

Column

width	25%

Export IFC Service

Column

width	25%

Export To Excel Service

Section

Column

width	25%

Hyperlink Service

Column

width	25%

Structure Service

Column

width	25%

Clash Service

Column

width	25%

User Settings Service

Section

Column

width	25%

Slideshow Service

Column

Comment Service

Column

width	25%

Lock 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

Section

Column

width	50%

Rights and Roles Service

Column

width	50%

Section

Column

width	25%

Share Service

Share a resource ( e.g. document )

Column

width	25%

Messaging Service

Column

width	25%

Object Navigator(filter) Service

Section

Column

width	25%

Export Object Service

Column

width	25%

Selection Object Service

Column

width	25%

Catalog Service

Section

Column

Bimplus Windows Explorer related Services

...

Update the project

...

id	bimUpdateProject

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	id of the project
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	date	Creation date of the project
changed	optional	date	Changed date of the project

Card

label	Description

Update or replace a specified existing project with a new one.

...

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


{
"shortDescr" : "Updating the project"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

...

Create an issue in the project

...

id	bimCreateIssue

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/issues

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	mandatory	guid	Id of the project
name	optional	string	Name of the issue
description	optional	string	Description of the issue
author	optional	string	Author of the issue
status	optional	string	Status of the issue
createdAt	optional	date	Creation date of the issue
dueDate	optional	date	The date in which the issue is planned to be finished
solution	optional
classification	optional	string
priority	optional	string

Card

label	Description

Creates a new issue in a project.

...

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


{
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author": "Mr. Smart",
"status": "open",
"createdAt": "2013-06-02T10:05:00",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON


{
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author": "Mr. Smart",
    "status": "open",
    "createdAt": "2013-06-02T10:05:00+00:00",
    "dueDate": "2013-06-05T10:05:00+00:00",
    "solution": null,
    "classification": "",
    "priority": "very high",
    "revision": null,
    "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}

...

Get the Issue List from the project

...

id	bimGetIssueList

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Get all the issues assigned to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

...

borderColor	Red
lang	xml
title	JSON

...

Delete all the issues from the project

...

id	bimDeleteIssueList

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/issues
Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Delete all the issues belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

...

borderColor	Red
lang	xml
title	JSON

...

Create a new attachment in the project

...

id	bimCreateAttachmentInProject

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/attachments

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the project objects to which the file has to be attached
fileName	optional	string	Name of the file to be attached to the project
type	optional	string	Mime type
size	optional	long	Size of the file to be attached to the project

Card

label	Description

Creates a new attachment in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the Attachment List from the project

...

id	bimGetAttachmentListFromProject

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/attachments

Card

label	Description

Get all the attachments belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete all the attachments from the project

...

id	bimDeleteAttachmentListFromProject

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Delete all the attachments belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the project disciplines

...

id	bimGetProjectDisc

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/disciplines

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/disciplines

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/disciplines

Card

label	Description

Get the disciplines of a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the project

...

id	bimDeleteProject

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Deletes a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Create a new object
Get the object tree with full property list whose geometry type is "mesh"(default)
Get the object with no children and fully property list whose geometry type is "mesh"(default)
Get the full property list of the object without geometry
Get the project topology tree
Get the object tree with full property list without geometry
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline
Update the object
Create a new attachment in the object
Get the attachment list from the object
Delete all attachments from the project
Delete the object

...

Create a new object

...

id	bimGetObject1

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: https://api.bimplus.net/v2/<company>/objects

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	guid	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional		Children of the object

Card

label	Description

Creates a new object

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the object tree with full property list whose geometry type is "mesh"(default)

...

id	bimGetObject2

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the object tree with full property list whose geometry type is "mesh"(default)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response
lang	xml

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the full property list of the object without geometry

...

id	bimGetObject4

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/nogeometry

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/nogeometry

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the full property list of the object without geometry

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the project topology tree

...

id	bimGetObject5

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/projecttree

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/projecttree

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the project topology tree.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the object tree with full property list without geometry

...

id	bimGetObject6

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/topology

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/topology

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the object tree with full property list without geometry.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"

...

id	bimGetObject7

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/geometries/threejs

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/geometries/threejs

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the optimized objects tree with selected property list whose geometry type is "ThreeJS".

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"

...

id	bimGetObject8

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/geometries/meshblob

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/geometries/meshblob

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline*

...

id	bimGetObject9

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline*

...

id	bimGetObject10

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob

URL: https://api.bimplus.net/v2/<company>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update the object*

...

id	bimObjectUpdate

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	Id of the object
parent	optional	guid	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional		Children of the object

Card

label	Description

Update or replace a specified existing object with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Create a new attachment in the object

...

id	bimObjCreateAttachment

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>attachments

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the objects to which the file has to be attached
fileName	optional	string	Name of the file to be attached to the project
type	optional	string	Mime type
size	optional	long	Size of the file to be attached to the project

Card

label	Description

Create a new attachment in a object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the attachment list from the object

...

id	bimGetObjAttachment

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>attachments

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get all the attachments belonging to a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete all the attachments from the project

...

id	bimDeleteObjAttachment

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/attachments

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Delete all the attachments from a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the object

...

id	bimObjDelete

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Deletes a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get all the element types
Get the element type properties
Get the list of exisiting disciplines

...

Get the element types

...

id	bimGetElementType

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: element-types

URL: https://api.bimplus.net/v2/<team>/element-types

Example: https://api.bimplus.net/v2/bimplus/element-types

Card

label	Description

Gets the list of existing element types.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  [3]
0:  {
type: "GeometryObject"
category: "/1/30/4/"
name: "3D object"
ifcType: "ID_IFCBuildingElementProxy"
id: "5a8a8670-cb9f-4f04-a467-04a9e416a6d0"
}-
1:  {
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}-
2:  {
type: "Column"
category: "/1/10/2/"
name: "Column"
ifcType: "ID_IFCColumn"
id: "2e308afe-d078-4c20-b53c-76b2da66d848"
}

...

Get the element type properties

...

id	bimGetElementTypeProp

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: element-types/<element_type_id>

URL: https://api.bimplus.net/v2/<team>/element-types/<element_id>

Example: https://api.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9

Card

label	Description

Get the properties of a specified element type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}

...

Get the list of existing disciplines

...

id	bimGetDisciplines

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: element-types/disciplines

URL: https://api.bimplus.net/v2/<team>/element-types/disciplines

Example: https://api.bimplus.net/v2/bimplus/element-types/disciplines

Card

label	Description

Gets the list of existing disciplines.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
-e79a4e18-383f-49c4-aabf-e15b27850423: {
category: "/14/"
name: "Airconditionermodel"
ifcType: null
id: "e79a4e18-383f-49c4-aabf-e15b27850423"
}
-63b069d2-81df-4418-91de-8a954fa12924: {
category: "/5/"
name: "Wood Construction Model"
ifcType: null
id: "63b069d2-81df-4418-91de-8a954fa12924"
}
-dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f: {
category: "/4/"
name: "Massiveconstructionmodel"
ifcType: null
id: "dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f"
}
-6a6e4d09-3550-4483-8134-98ac1e6c1afb: {
category: "/60/"
name: "Production model"
ifcType: null
id: "6a6e4d09-3550-4483-8134-98ac1e6c1afb"
}
-09e623d4-1e12-4a77-b358-ea1d0b28e4a7: {
category: "/2/"
name: "Roommodel"
ifcType: null
id: "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
}
-687c6451-3fa1-47e0-9f13-406833bb06f3: {
category: "/13/"
name: "TGA_Wastewatermodel"
ifcType: null
id: "687c6451-3fa1-47e0-9f13-406833bb06f3"
}
}

...

Note
Not used in the current edition!

Attachment Service

...

Get attachment information
Download the attachment
Update the attachment
Delete the attachment

...

Get Attachment information

...

id	bimGetAttachmentList

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get detailed information about a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Download the attachment

...

id	bimDownloadAttachment

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/download

URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>/download

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Download the content of a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update the attachment

...

id	bimUpdateAttachment

Card

label	Implementation Status

Image Removed Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the objects to which the file has to be attached
fileName	optional	string	Name of the file to be attached to the project
type	optional	string	Mime type
size	optional	long	Size of the file to be attached to the project

Card

label	Description

Update or replace a specified existing attachment with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the Attachment

...

id	bimDeleteAttachment

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Deletes a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Issue Service

...

Get details of the issue
Get all the issue types
Get details of the issue type
Create a new pin for the issue
Get all the pins of the issue
Delete all the pins from the issue
Create a new comment for the issue
Get all the comments of the issue
Delete the comment
Create a new attachment for the issue
Get the attachment list from the issue
Delete all the attachments from the issue
Update the issue
Delete the issue

...

Get details of the issue

...

id	bimGetIssueDetails

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get details of an issue present in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get all the issue types

...

id	bimGetIssueTypest

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types

URL: https://api.bimplus.net/v2/<company>/issues/types

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get all the available issue types.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get details of the issue type

...

id	bimGetIssueTypeDetails

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types/<type_id>

URL: https://api.bimplus.net/v2/<company>/issues/types/<type_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get details of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Create a new pin for the issue

...

id	bimCreatePin

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<company>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId		guid	The id of the issue to which the pin is related
objectId			The id of the object to which the pin is related
position	optional
normalVector	optional
createdAt	optional	date	The creation date

Card

label	Description

Create a new pin for an issue for relating the issue with its object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get all the pins of the issue

...

id	bimGetAllPins

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get all the pins of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete all the pins from the issue

...

id	bimDeleteAllPins

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Delete all the pins from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Create a new comment for the issue

...

id	bimCreateComment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Type	Description
issueId	guid	The id of the issue to which the comment is related
text	string	The comment text
createdAt	date	Creation date of the comment
author	string	The author of the comment

Card

label	Description

Create a new comment for a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get all the comments of the issue

...

id	bimGetAllComments

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get all the comments of a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the comment

...

id	bimDeleteComment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments/<comment_id>

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments/<comment_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Deletes a specified comment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Create a new attachment for the issue

...

id	bimCreateAttachmentForIssue

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the issue objects to which the file has to be attached
fileName	optional	string	Name of the file to be attached to the project
type	optional	string	Mime type
size	optional	long	Size of the file to be attached to the project

Card

label	Description

Creates a new attachment for a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the attachment list from the issue

...

id	bimGetAttachmentListFromIssue

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Gets the attachment list from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete all the attachments from the issue

...

id	bimDeleteAttachmentFromIssue

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update the issue

...

id	bimUpdateIssue

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Type	Description
projectId	guid	Id of the project
name	string	Name of the issue
description	string	Description of the issue
author	string	Author of the issue
status	string	Status of the issue
createdAt	date	Creation date of the issue
dueDate	date	The date in which the issue is planned to be finished
solution
classification	string
priority	string

Card

label	Description

Update or replace a specified existing issue with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the issue

...

id	bimDeleteIssue

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Deletes a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Pin Service

...

Get details of the pin
Update the pin
Delete the pin

...

Get details of the pin

...

id	bimGetPinDetails

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get details of a specified pin.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update the pin

...

id	bimPinUpdate

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Update or replace a specified existing pin with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the pin

...

id	bimGetPinDetails

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Deletes a specified pin.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Import Service

...

Create a new project by importing SketchUp and IFC files.
Create a new sub-project by importing SketchUp and IFC files.

...

Create a new project by importing SketchUp and IFC files

...

id	bimCreateProjectFromIFC

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: import

URL: https://api.bimplus.net/v2/<company>/import

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Create a new project by importing SketchUp and IFC files into the team database.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Create a new sub-project by importing SketchUp and IFC files

...

id	bimCreateSubProjectFromIFC

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/import

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/import

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Create a new sub-project by importing SketchUp and IFC files into the project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Authorization Service

...

Authenticate by requesting and receiving a token
Get token information
Revoke / Terminate the token

...

Authenticate by requesting and receiving a token

...

id	bimAuthenticateToken

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: authorize

URL: https://api.bimplus.net/v2/<company>/authorize

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Authenticate by requesting and receiving a token.

...

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


{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON


{
"access_token": "9c1874a62c974dcfa75e0132c423a088"
"expires_in": 2591999
"token_type": "BimPlus"
}

...

Get token information

...

id	bimGetTokenInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: tokeninfo?access_token=<token>

URL: https://api.bimplus.net/v2/<company>/tokeninfo?access_token=<token>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about a specified token.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Revoke / Expire the token

...

id	bimExpireToken

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: revoke?token=<token>

URL: https://api.bimplus.net/v2/<company>/revoke?token=<token>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

The specified token will expire immediately.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

User Management Service

...

Create a new user
Get information about the user
Update information about the user
Get information about the currently logged in user

...

Create a new user

...

id	bimCreateUser

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: users

URL: https://api.bimplus.net/v2/<company>/users

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Type	Description
email	string	Email of the user
status	string
password	string	Password of the user

Card

label	Description

Creates a new user account.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get information about the user

...

id	bimGetUserInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/<company>/users/<user_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update information about the user

...

id	bimUpdateUserInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/<company>/users/<user_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Type	Description
email	string	Email of the user
status	string
password	string	Password of the user

Card

label	Description

Update information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get information about the currently logged in user

...

id	bimGetCurrentUserInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

URL: https://api.bimplus.net/v2/<company>/user

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about the currently logged in user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Team Management Service

...

Create a new team and its related database
Get information about the team
Update information about the team
Get the team list in which the current logged in user is a member of

...

Create a new team and its related database

...

id	bimCreateNewTeam

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

URL: https://api.bimplus.net/v2/<company>/teams

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	optional	guid	Id of the team
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	guid	The unique identifier of the user who will be the initial owner
totalStorage	optional		The total storage allocated to the the team
storageStats	optional		The storage statistics of the team
status	optional	string
teamWorksConnection	optional	string
dataStorageStatus	optional	string

Card

label	Description

Create a new team and its related database.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get information about the team

...

id	bimGetTeamInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

URL: https://api.bimplus.net/v2/<company>/teams/<team_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update information about the team

...

id	bimUpdateTeamInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

URL: https://api.bimplus.net/v2/<company>/teams/<team_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	optional	guid	Id of the team
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	guid	The unique identifier of the user who will be the initial owner
totalStorage	optional		The total storage allocated to the the team
storageStats	optional		The storage statistics of the team
status	optional	string
teamWorksConnection	optional	string
dataStorageStatus	optional	string

Card

label	Description

Update information about a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the team list in which the current logged in user is a member of

...

id	bimGetTeamFromCurrentUser

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

URL: https://api.bimplus.net/v2/<company>/teams

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get a team list in which the current logged in user is a member of

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Membership Management Service

...

Add the user to the team
Get the member list of the team
Update information about the user in the team
Delete the user from the team

...

Add the user to the team

...

id	bimAddUserToTeam

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members

URL: https://api.bimplus.net/v2/<company>/<team_id>/members

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Add a specified user to a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the member list of the team

...

id	bimGetMemberListInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members

URL: https://api.bimplus.net/v2/<company>/<team_id>/members

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update information about the user in the team

...

id	bimUpdateUserInfoInTeam

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members/<user_id>

URL: https://api.bimplus.net/v2/<company>/<team_id>/members/<user_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Update information about a specified user in a team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Delete the user from the team

...

Deck of Cards

id	bimDeleteUserFromTeam

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members/<user_id>

URL: https://api.bimplus.net/v2/<company>/<team_id>/members/<user_id>

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Deletes a specified user from a team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

[3] 0: { id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Bim+ Services

Project Service

Create a new project

Get the Project List

Get the Project Properties

Project relevant services

Administration relevant services

Other services

Project Service

Model Service

Object Service

Custom attribute Service

Revision Service

CustomTable Service

Cross Section Service

Connection Service

ElementType Service

Attachment Service

Issue Service

Pin Service

BCF Service

Import Service

Export IFC Service

Export To Excel Service

Hyperlink Service

Structure Service

Clash Service

User Settings Service

Slideshow Service

Comment Service

Lock Service

Authorization Service

User Management Service

Team Management Service

Membership Management Service

Rights and Roles Service

Share Service

Messaging Service

Object Navigator(filter) Service

Export Object Service

Selection Object Service

Catalog Service

Bimplus Windows Explorer related Services

Update the project

Create an issue in the project

Get the Issue List from the project

Delete all the issues from the project

Create a new attachment in the project

Get the Attachment List from the project

Delete all the attachments from the project

Get the project disciplines

Delete the project

Create a new object

Get the object tree with full property list whose geometry type is "mesh"(default)

Get the full property list of the object without geometry

Get the project topology tree

Get the object tree with full property list without geometry

Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"

Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline*

Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline*

Update the object*

Create a new attachment in the object

Get the attachment list from the object

Delete all the attachments from the project

Delete the object

Get the element types

Get the element type properties

Get the list of existing disciplines

Attachment Service

Get Attachment information

Download the attachment

Update the attachment