This web page is under construction. The JSON Request and Response (Request and Response tab) for the API calls are not complete.
Please use http://bimplus-dev.mantro.net for the testing purposes because our productive server https://api.bimplus.net is not available to the market yet.
Bim+ Services
- Project Service
- Object Service
- ElementType Service
- Division Service
- Attachment Service
- Issue Service
- Pin Service
- Import Service
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 topology
- Get the project disciplines
- Delete the project
Create a new project
Service available !
POST
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 |
Creates a new project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "name" : "Your Awesome Building", "shortDescr" : "Example for creating a project" }
Status: 201 Created
{ "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
Service available !
GET
Resource: projects
URL: https://api.bimplus.net/v2/<team>/projects
Example: https://api.bimplus.net/v2/bimplus/projects
Gets the available project list with main properties.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[ { "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
Service available !
GET
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
Get all the project properties of a project using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "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" }
Update the project
Service available !
PUT
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 |
---|---|---|---|
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 |
Update or replace a specified existing project with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "shortDescr" : "Updating the project" }
Status: 200 OK
Create an issue in the project
Service available !
POST
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 |
|
Creates a new issue in a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/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" }
Status: 201 Created
{ "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
Service available !
GET
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
Get all the issues assigned to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "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" }
Delete all the issues from the project
Service available !
DELETE
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
Delete all the issues belonging to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new attachment in the project
Service available !
POST
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 |
Creates a new attachment in a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
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
Get all the attachments belonging to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
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
Delete all the attachments belonging to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: projects/<project_id>/topology
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/topology
Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/topology
Get the project topology tree.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "parent": null, "name": null, "type": "Project", "children": [ { "parent": "c8c8e6f2-4495-484c-929d-0049f1f9d4ff", "name": null, "type": "ID_TopologyDivision", "children": [], "id": "195db084-3715-4ebc-b164-3ee47a495b2e" } ], "id": "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" }
Get the project disciplines
Service available !
GET
Resource: projects/<project_id>/disciplines
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/disciplines
Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines
Get the disciplines of a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[ { "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": [] } ]
Delete the project
Service available !
DELETE
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
Deletes a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Object Service
- 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 object tree with full property list without geometry (object topology tree)
- 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
Service available !
POST
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 |
Creates a new object
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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)
Service available !
GET
Resource: objects/<object_id>
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Get the object tree with full property list whose geometry type is "mesh"(default)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: objects/<object_id>/nogeometry
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/nogeometry
Example: https://api.bimplus.net/v2/bimplus/projects
Get the full property list of the object without geometry
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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 (object topology tree)
Service available !
GET
Resource: objects/<object_id>/topology
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/topology
Example: https://api.bimplus.net/v2/bimplus/projects
Get the object tree with full property list without geometry.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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"
Service available !
GET
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
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS".
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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)"
Service available !
GET
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
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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*
Service available !
GET
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
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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*
Service available !
GET
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
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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*
Service available !
PUT
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 |
---|---|---|---|
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 |
Update or replace a specified existing object with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
POST
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 |
Create a new attachment in a object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: objects/<object_id>attachments
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>attachments
Example: https://api.bimplus.net/v2/bimplus/projects
Get all the attachments belonging to a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
Resource: objects/<object_id>/attachments
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/projects
Delete all the attachments from a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
Resource: objects/<object_id>
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Deletes a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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" }
ElementType Service
- Get all the element types
- Get the element type properties
- Get the list of exisiting disciplines
Get the element types
Service available !
GET
Resource: element-types
URL: https://api.bimplus.net/v2/<team>/element-types
Example: https://api.bimplus.net/v2/bimplus/element-types
Gets the list of existing element types.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
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
Get the properties of a specified element type.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ type: "Chimney" category: "/1/10/8/" name: "Chimney" ifcType: "ID_IFCBuildingElementProxy" id: "e504f24c-e643-452b-b901-6a18883dc7e9" }
Get the list of existing disciplines
Service available !
GET
Resource: element-types/disciplines
URL: https://api.bimplus.net/v2/<team>/element-types/disciplines
Example: https://api.bimplus.net/v2/bimplus/element-types/disciplines
Gets the list of existing disciplines.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ -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" } }
Division Service
Not used in the current edition!
Attachment Service
- Get attachment information
- Download the attachment
- Update the attachment
- Delete the attachment
Get Attachment information
Service available !
GET
Resource: attachments/<attachment_id>
URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Get detailed information about a specified attachment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: attachments/<attachment_id>/download
URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>/download
Example: https://api.bimplus.net/v2/bimplus/projects
Download the content of a specified attachment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
GET
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 |
Update or replace a specified existing attachment with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: attachments/<attachment_id>
URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Deletes a specified attachment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: issues/<issue_id>
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Get details of an issue present in a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
GET
Resource: issues/types
URL: https://api.bimplus.net/v2/<company>/issues/types
Example: https://api.bimplus.net/v2/bimplus/projects
Get all the available issue types.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
GET
Resource: issues/types/<type_id>
URL: https://api.bimplus.net/v2/<company>/issues/types/<type_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Get details of a specified issue type.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
POST
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 |
Create a new pin for an issue for relating the issue with its object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: issues/<issue_id>/pins
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins
Example: https://api.bimplus.net/v2/bimplus/projects
Get all the pins of a specified issue type.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
Resource: issues/<issue_id>/pins
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins
Example: https://api.bimplus.net/v2/bimplus/projects
Delete all the pins from a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
POST
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 |
Mandatory / Optional |
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 |
Create a new comment for a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
GET
Resource: issues/<issue_id>/comments
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments
Example: https://api.bimplus.net/v2/bimplus/projects
Get all the comments of a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
DELETE
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
Deletes a specified comment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
POST
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 |
Creates a new attachment for a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: issues/<issue_id>/attachments
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/projects
Gets the attachment list from a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
Resource: issues/<issue_id>/attachments
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/projects
Delete all the attachments from a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
PUT
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 |
Mandatory / Optional |
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 |
|
Update or replace a specified existing issue with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
Resource: issues/<issue_id>
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Deletes a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: pins/<pin_id>
URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Get details of a specified pin.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
PUT
Resource: pins/<pin_id>
URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>
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 |
Update or replace a specified existing pin with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
Resource: pins/<pin_id>
URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>
Example: https://api.bimplus.net/v2/bimplus/projects
Deletes a specified pin.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
POST
Resource: import
URL: https://api.bimplus.net/v2/<company>/import
Example: https://api.bimplus.net/v2/bimplus/projects
Create a new project by importing SketchUp and IFC files into the team database.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service not finished yet !
POST
Resource: projects/<project_id>/import
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/import
Example: https://api.bimplus.net/v2/bimplus/projects
Create a new sub-project by importing SketchUp and IFC files into the project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
POST
Resource: authorize
URL: https://api.bimplus.net/v2/authorize
Example: https://api.bimplus.net/v2/authorize
Authenticate by requesting and receiving a token.
Content-Type: application/json
{ "user_id" : "test@bimplus.net", "password" : "test" }
Status: 200 OK
{ "access_token": "9c1874a62c974dcfa75e0132c423a088" "expires_in": 2591999 "token_type": "BimPlus" }
Get token information
Service available !
GET
Resource: tokeninfo?access_token=<token>
URL: https://api.bimplus.net/v2/tokeninfo?access_token=<token>
Example:
Get information about a specified token.
Content-Type: application/json
Status: 200 OK
{ "user_id": "b37b60d4-0f1b-4158-99c4-847254786517", "audience": "00000000-0000-0000-0000-000000000000", "expires_in": 2271650 }
Revoke / Expire the token
Service available !
GET
Resource: revoke?token=<token>
URL: https://api.bimplus.net/v2/revoke?token=<token>
Example:
The specified token will expire immediately.
Content-Type: application/json
Status: 200 OK
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
Service available !
POST
Resource: users
URL: https://api.bimplus.net/v2//users
Example: https://api.bimplus.net/v2/users
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
|
string |
Email of the user |
|
status |
|
string |
|
password |
|
string |
Password of the user |
Creates a new user account.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "email" : "test@bimplus.net", "password" : "test" }
Status: 201 Created
{ "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active" }
Get information about the user
Service available !
GET
Resource: users/<user_id>
URL: https://api.bimplus.net/v2/users/<user_id>
Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
Get information about a specified user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active" }
Update information about the user
Service available !
PUT
Resource: users/<user_id>
URL: https://api.bimplus.net/v2//users/<user_id>
Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
|
string |
Email of the user |
|
status |
|
string |
|
password |
|
string |
Password of the user |
Update information about a specified user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get information about the currently logged in user
Service available !
GET
Resource: user
URL: https://api.bimplus.net/v2/user
Get information about the currently logged in user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "email": "test@bimplus.net", "status": "Active" }
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
Service available !
POST
Resource: teams
URL: https://api.bimplus.net/v2/teams
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
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 (the initial storage size as ordered in the shop) |
storageStats |
optional |
|
The storage statistics of the team |
status |
optional |
string |
Active / Inactive |
teamWorksConnection |
optional |
string |
Base64 encoded database connection string for legacy applications |
dataStorageStatus |
optional |
string |
Online / Offline |
Create a new team and its related database.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==", "dataStorageStatus": "Online" }
Status: 201 Created
{ "id": "db038754-2598-4616-9ea2-2c0947f2e93a", "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000, "storageStats": { "usedSpace": 0, "numberOfProjects": 0, "numberOfMembers": 0, "totalSpace": 500000, "totalNumberOfProjects": 0, "totalNumberOfMembers": 0 }, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==", "dataStorageStatus": "Online" }
Get information about the team
Service available !
GET
Resource: teams/<team_id>
URL: https://api.bimplus.net/v2/teams/<team_id>
Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a
Get information about a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
PUT
Resource: teams/<team_id>
URL: https://api.bimplus.net/v2/teams/<team_id>
Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
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 (the initial storage size as ordered in the shop) |
storageStats |
optional |
|
The storage statistics of the team |
status |
optional |
string |
Active / Inactive |
teamWorksConnection |
optional |
string |
Base64 encoded database connection string for legacy applications |
dataStorageStatus |
optional |
string |
Online / Offline |
Update information about a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: teams
URL: https://api.bimplus.net/v2/teams
Get a team list in which the current logged in user is a member of
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[ { "id": "db038754-2598-4616-9ea2-2c0947f2e93a", "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==", "dataStorageStatus": "Online" }, { "id": "82884f54-96bf-4e9c-a2fb-44db8379378d", "slug": "nemetschek", "name": "Nemetschek", "owner": "132a78a5-b523-4bf2-8382-7098fac3f803", "totalStorage": 0, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==", "dataStorageStatus": "Online" }, { "id": "7eab1453-a4e7-4d05-983e-031544540e6f", "slug": "bimplus-demo", "name": "BimPlusDemo", "owner": "5592c628-588e-f5c0-b08b-088d43de9209", "totalStorage": 53687091200, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=", "dataStorageStatus": "Online" } ]
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
Service available !
POST
Resource: <team_id>/members
URL: https://api.bimplus.net/v2/<company>/<team_id>/members
Example: https://api.bimplus.net/v2/bimplus/projects
Add a specified user to a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
GET
Resource: <team_id>/members
URL: https://api.bimplus.net/v2/<company>/<team_id>/members
Example: https://api.bimplus.net/v2/bimplus/projects
Get information about a specified user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
PUT
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
Update information about a specified user in a team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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
Service available !
DELETE
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
Deletes a specified user from a team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[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" }