Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.
Please use http://bimplus-dev.mantro.net (API) and http://nemetschek.dev2.shoptimax.de/ (Shop/Portal) for the testing purposes because our productive server https://api.bimplus.net is not available to the market yet.
Project relevant services
Administration relevant services
Other 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 topology
- Get the project layers
- Create / Upload a thumbnail to the project
- Download the thumbnail
- Delete the project
Object Service
- Create a new object
- Get the object details
- 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 layer
- Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer
- Update the object
- Create a new attachment in the object
- Get the attachment list from the object
- Delete all attachments from the object
- Delete the object
Attachment Service
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 all the comments from the issue
- 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
Authorization Service
User Management Service
Team Management Service
Membership Management Service
Rights & Roles Service
- Get all the available roles
- Make a team member part of a project by assigning a role to him
- Get the project members along with their respective roles
- Update the project role of a team member
- Remove the user from the project
Project Service
A Project is basically a holder which contains building models.
Create a new project
Resource: projects
URL: https://api.bimplus.net/v2/<team_slug>/projects
Example: https://api.bimplus.net/v2/bimplus/projects
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
mandatory |
string |
Name of the project |
shortDescr |
optional |
string |
Short description of the project |
created |
will be ignored |
string (date) |
Creation date of the 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
Resource: projects
URL: https://api.bimplus.net/v2/<team_slug>/projects
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",
"hasWriteAccess": false,
"teamSlug": "company1",
"rights": {
"projectAdmin": false,
"projectDelete": false,
"projectEdit": false,
"modelsCreate": false,
"modelsViewAll": false
}
},
{
"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",
"hasWriteAccess": true,
"teamSlug": "best-company",
"rights": {
"projectAdmin": true,
"projectDelete": true,
"projectEdit": true,
"modelsCreate": true,
"modelsViewAll": true
}
},
{
"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",
"hasWriteAccess": false,
"teamSlug": "company2",
"rights": {
"projectAdmin": false,
"projectDelete": false,
"projectEdit": false,
"modelsCreate": false,
"modelsViewAll": true
}
}
]
Get the Project Properties
Resource: projects/<project_id>
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>
Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2
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": []
}
],
"rights": {
"projectAdmin": false,
"projectDelete": false,
"projectEdit": false,
"modelsCreate": false,
"modelsViewAll": true
},
"id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}
Update the project
Resource: projects/<project_id>
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the project |
shortDescr |
optional |
string |
Short description of the project |
created |
will be ignored |
string (date) |
Creation date of the project |
changed |
will be ignored |
string (date) |
Changed date of the project |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"properties": {
"MainFloorArea": "456m²",
"Architect": {
"name": "NemetschekTech.GmbH",
"phone1": "089/12793-1115",
"phone2": "0171/71384483",
"email": "MyName@Nemetschek.com",
"city": "Munich",
"zip": "81829",
"street": "Konrad-Zuse-Platz1"
},
"Customer": {
"name": "Bimplus customer",
"phone1": "001-201-1279345",
"email": "MyName@Nemetschek.com",
"city": "New Jersy",
"zip": "08201"
}
}
}
Status: 200 OK
Create an issue in the project
Resource: projects/<project_id>issues
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/issues
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| shortId | will be ignored | number | Readable unique issue number |
projectId |
will be ignored |
string (guid) |
Id of the project |
name |
optional |
string |
Name of the issue |
description |
optional |
string |
Description of the issue |
author |
optional |
object |
Author of the issue |
| responsible | optional | object | Responsible person for the issue |
status |
optional |
string |
Status of the issue |
createdAt |
will be ignored |
string (date) |
Creation date of the issue |
dueDate |
optional |
string (date) |
The date in which the issue is planned to be finished |
solution |
optional |
string |
The proposed solution for the issue |
classification |
optional |
string |
The classification to which the issues belongs |
priority |
optional |
string |
The priority of the issue |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
"responsible" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },
"status": "open",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}
Status: 201 Created
{
"shortId": 1
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
"responsible" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },
"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
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/issues
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"shortId": 1,
"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"
},
{
"shortId": 2,
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Geometry information missing for wall",
"description": "The geometry information is missing for the wall in the kitchen",
"author": "Mr. Architect",
"status": "open",
"createdAt": "2013-06-02T10:05:00+00:00",
"dueDate": "2013-06-05T10:05:00+00:00",
"solution": null,
"classification": "",
"priority": "high",
"revision": null,
"id": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
}
]
Delete all the issues from the project
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/issues
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new attachment in the project
Resource: projects/<project_id>/attachments
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments
JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
objectIds |
will be ignored |
string |
The id of the project objects to which the file has to be attached |
fileName |
will be ignored |
string |
Name of the file to be attached to the project |
type |
will be ignored |
string |
Mime type |
size |
will be ignored |
integer |
Size of the file to be attached to the project |
| createdAt | will be ignored | string | Creation time of the attachment |
| creator | will be ignored | object | The user who created the attachment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 201 Created
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Get the Attachment List from the project
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Delete all the attachments from the project
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get the project topology tree
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/topology
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"parent": null,
"name": null,
"type": "Project",
"children": [
{
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": null,
"type": "ID_TopologyDivision",
"children": [],
"id": "195db084-3715-4ebc-b164-3ee47a495b2e"
}
],
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
Get the project layers
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/disciplines
Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines
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": []
}
]
Create / Upload a thumbnail to the project
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Thumbnail API call:
Status: 201 Created
{
fileName: "MyThumbnail.jpg"
type: "image/jpeg"
size: 5262
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
Download the thumbnail
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail/download
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail/download
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 200 OK
Delete the project
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>
Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Object Service
Objects are the primary component of the project tree and it exists in two forms.
- Node: Objects with no graphical representation
- Geometry: Objects with graphical representation (See Geometry)
Please see the detailed structure of the issue in the Object Model
Create a new object
Resource: objects
URL: https://api.bimplus.net/v2/<team_slug>/objects
Example: https://api.bimplus.net/v2/bimplus/objects
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
parent |
optional |
string (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 |
Object |
Children of the object |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"type": "Wall",
"attributes": {
"element": {
"isparent": false,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"quantity": {
"width": 115
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
Status: 201 Created
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"type": "Wall",
"attributes": {
"element": {
"isparent": false,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"quantity": {
"width": 115
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
Get the object details
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"type": "Wall",
"attributes": {
"element": {
"isparent": false,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
Get the full property list of the object without geometry
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/nogeometry
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/nogeometry
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"type": "Wall",
"attributes": {
"element": {
"isparent": false,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
}
}
}
Get the object tree with full property list without geometry (object topology tree)
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/topology
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/topology
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"parent": null,
"name": "Brickwall",
"type": "Project",
"children": [],
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
}
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/threejs
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"elementsCount": 1,
"viewbox": {
"x": -5081.562,
"y": 5005.8785,
"z": 1231.1029999999996,
"width": 5950,
"height": 5540.835,
"depth": 7065.71
},
"colors": [
-9868951
],
"objects": [
{
"id": "f5cc3c6c-1fdf-499d-a38d-0582adadc216",
"type": "RoofLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
0,
2,
1,
3,
0,
5,
3,
9,
1,
1,
14,
1,
5,
6,
15,
12,
1,
7,
4,
13,
14
],
"vertices": [
-2106.562,
7588.114,
-2301.752,
-8056.562,
7588.114,
-2301.752,
-8056.562,
-880.999,
-4742.212,
6700,
-880.999,
-4742.212,
7412.539,
-1821.578,
-5522.212,
7412.539,
-1821.578
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 7065.71,
"height": 150,
"volume": 7911354818.818842,
"area": 52742365.4587924
},
"general": {
"name": "<PP>RoofLayer"
}
}
}
]
}
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/meshblob
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/meshblob
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"elementsCount": 1,
"objects": [
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"parent": "00000000-0000-0000-0000-000000000000",
"type": "Wall",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3XrNpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunTBYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRmzpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQSKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBbDZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+RWOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwBnAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+eSnz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezdPOiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPhr5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhGPdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4cfXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDhNX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRNlL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4wxaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
}
]
}
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"elementsCount": 4,
"faceCount": 154,
"viewbox": {
"x": 4067.5,
"y": -480,
"z": -4652.5,
"width": 9775,
"height": 600,
"depth": 9695
},
"colors": [
-4272966
],
"objects": [
{
"id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
"parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
8955,
-780,
-9580,
-820,
-780,
-9580,
-820,
-780,
-9500,
8955,
-780,
-9500,
8955,
-180,
-9580,
-820,
-180,
-9580,
-820,
-180,
-9500,
8955,
-180,
-9500
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9775,
"width": 80,
"height": 600,
"volume": 469200000.0000012,
"area": 5865000.000000014
},
"general": {
"name": "<PP>Wall layer"
}
}
},
{
"id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
"parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
-820,
-780,
-9500,
-820,
-780,
115,
-740,
-780,
115,
-740,
-780,
-9500,
-820,
-180,
-9500,
-820,
-180,
115,
-740,
-180,
115,
-740,
-180,
-9500
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9615,
"width": 80,
"height": 600,
"volume": 461520000.0000002,
"area": 5769000.000000003
},
"general": {
"name": "<PP>Wall layer"
}
}
},
{
"id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
"parent": "b62c83db-69ea-485b-9315-26826110e578",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
-820,
-780,
195,
8875,
-780,
195,
8875,
-780,
115,
-820,
-780,
115,
-820,
-180,
195,
8875,
-180,
195,
8875,
-180,
115,
-820,
-180,
115
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9695,
"width": 80,
"height": 600,
"volume": 465359999.99999976,
"area": 5816999.999999998
},
"general": {
"name": "<PP>Wall layer"
}
}
},
{
"id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
"parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
8955,
-780,
195,
8955,
-780,
-9500,
8875,
-780,
-9500,
8875,
-780,
195,
8955,
-180,
195,
8955,
-180,
-9500,
8875,
-180,
-9500,
8875,
-180,
195
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9695,
"width": 80,
"height": 600,
"volume": 465360000.00000006,
"area": 5817000
},
"general": {
"name": "<PP>Wall layer"
}
}
}
]
}
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"elementsCount": 4,
"objects": [
{
"id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
"parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVX624TRxTe2Yu9TkocIIQ7mDSXtpgljh0gldIGXBqhRsiCwJ/Imq7XQ9hmvaZ7QXUqFbXqg7Tq/z5DpT5Ef/cdeuXSdr7tjNkaOazURIGN5tucM2fnfOfsOTNrhSiK8je/cMf1hsrhTqNxNYoCt9VwnSgO2HrvAauWS3dZELpdf3lhvlKx5q3alUuLVqVaW+JT9diD4bLP4iiwvXKpEbc81/mI9da7W8xf9mPPM+CjfJN1WBQ699mWdfNO5Hprbiuwg55Vv2aH7LrHZ/2o0fV6rM2CPH/AeNB1/Uhn7U2m37MdZnboLbvtxuFYh15jftv1N4Ou5zE94iTVGx9omqbruvYtud0LI9ax6ph0Is47tFaZzwLXsdbcMPq4srExlEufB3fNY9mLbDSb3+wGxes8L682ww/5S9szhlNDvXdjP7oaBHYPBZ3RbHqYmSxI0IbhqMjLauy2IRc0gA4wADkOI8afvK8yLYnGyD+0vZhRqphYUBtXFP0P/nza0yifUKmt0pZKHZW2VcpUek+lmyq9r1JXpZ+odEt5fpn5vCouZeDSQfg16BHQzFGXkwwNGrrbzKQP/12TJ3suE7eNJqI3zUIBNzF0vKtXvwF3DH82C7V+9CPY3MXQjd2Kfk+b+/9FD2r96NE6OTGMXPYdodChiYIF/Ny5iw4NNe2LDIkTJjf8qLpQLnVCpxt4but5Umo8I/zv5aloXb5sLzqLlypL1Rqbv7LUbD7K7v42Px09tsv+k7ygjAoHsG+hrRQi+2omU08mS4wBioBxwEHAIcBhwATgCByMSAcw04duqOmqT9afBBwFHAMcB5wAnAScApwGnAGcBZQA5zgc0POj/wnrpV5RbYnXKcCbgGnADGAWMId1VR2J2+cCGt5XeTSLWXgLIcuBl7zfJbcj41HO+O0UYwOFla0OsS75jPTINhzkcniDn098v/rl0R9XPl0e+ek7ZX0F8s/bX79PUKpjwgCKFwzGBwwG7+RgygAuXjA4NGAgXWB64oevVsjhIRz6BhNDOPQNjgzhIA2MyZ0+hAabzGixTdfX+Hc4KkcVbwBtQ9B5k0LABDkmFMn3DRTHhUKTj50QCkO0HTkpFBDwY4CcEoq82MvJaaHIicfImZTbRHE25TZ5pJRymyx6Tih04cmYypICdHziBD9Nwv0+FJK95x1Eg70n2YTOQ5qWUhnSjJQuQJqVkgVpTkoXORTlFmDix+FffDzj4ykfRdlqfIN8r64oa3y8y8ejOoH75FyYT3UjOS+1lbS2LLULae0Fqa2mtZbU1tLai1K7mNIWpWtTlp0srqJ0bxqiEPLidRclhSRWLPmE339HrJKGiQzgoMMn+W+YkVRM5AUnFD72f8WMpGMiWzhFHvP7L/j/H73mm6ltDwAA",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAICF61G4/o3CQAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
},
{
"id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
"parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TiAOEFLumDSXtpgljh0gSGkDhkaoEbJK4CWypuv1ELZZr+leUJ1KoFb9IUW88xuqvvQn9Ln/ofcbnW87Y5YUh5WaKHSj+SbnzNk535w5Z2atEEVRnvEHPZ59KofbjcaVKArcVsN1ojhgq737rFou3WFB6Hb9xbnZSsWatWqXLsxblWptgQ/VYw+Giz6Lo8D2yqVG3PJc5wPWW+1uMH/Rjz3PgI/yTdZhUejcYxvWzduR6624rcAOelb9qh2y6x4f9aNG1+uxNgvy/AXjftf1I52115l+13aY2aEf2m03Dkc69Crz266/HnQ9j+kRJ6neuKZpmq7r2mNyqxdGrGPVMehEnHdoLTOfBa5jrbhh9FFlbW0glz4P7pqvZTei0Wx+tRMUr/O4vN4M3+ebtmsMJwZ678Z+dCUI7B4SOqPZ5CAzmZCgDcNhEZfl2G1DLmgAHWAAchyGjF95XWWaEoWRf2B7MaNUMTGhNqoo+i/8/bSnYT6gUlulLZU6Km2rlKn0rkrXVXpPpa5KP1bphvL8MfN5VTzKlkcH4f9BjYBmjrqcZGjQ0N1kJn3wz5w82DOZuK01sXrTLBTQiaZjr17/Atx2+dNZqPVXP4TDXTTd2KnV72px/7fVg1p/9SidnGhGLvuJUOjQRMECfu/cQYWGmvYwQ+CEyQ0/qs6VS53Q6Qae23oelBqPCP97dShaFy/a8878hcpCtcZmLy00m4+yu7/Fb0eP7bD/JC5Io8J+nFsoK4XIuprKVJPJFCOAImAUcABwEHAIMAY4DAdD0gHM9IEHajrrk/nHAW8AjgCOAo4BjgNOAE4CTgFOA0qAMxz26/nhF5b1Sq/ItsTrBOBNwCRgCjANmMG8qo7A7XECDa6rPIrFLLyFJcuGTd7rlNuW8TBn/HaKsYHEypaHmJd8SnpkEw5yOezgZ2NPl7/f/PI99J9/+82SlAlSdWSLQbono8Lgk8Wh754oq0v/MjjwEoMXXBx8iQsYQBr7+oslcmgAh77B2AAOfYPDAzhIA2N8uw+hrUVmtNi662v8OxyZo4odQNkQVN64EDBAjghF8n0DxVGh0ORrx4TCEGVHjgsFBPwYICeEIi/OcnJSKHLiNXIq5TZRnE65TV4ppdwmk54RCl14MiayhAAVnzjBT5Nwry+F5Ox5B6vB2ZMcQmchTUqpDGlKSucgTUvJgjQjpfMcivIIMPHj8C/e/uTtD96KstT4AfluXVFWeLvM26M6gfvkXphNVSM5K7WVtLYstXNp7Tmpraa1ltTW0trzUjuf0hala1OmnUyuonRvGiIR8mK7i5JCslZM+Tvvf8ZaJQ0TEcBFh0/ynzAiqZiIC24ofOz/iBFJx0S0cIv8xvsf8P/f/WbD220PAAA=",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACA/kbhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAAPwrXo8BcwAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
},
{
"id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
"parent": "b62c83db-69ea-485b-9315-26826110e578",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TkocIIQ7mJBLC2aJYwdIpbSASyNEhKwSeIms6Xo9hCXrNewF1alU1Ko/pFXf+xuq/ok+9xf0pff7fMuMWYwcVmqi0I3mm8yZs3O+c+acmbVCFEX5hz/o8byhcrjbaFyLosBtNVwnigO21nvEquXSPRaEbtdfXpivVKx5q3bl0qJVqdaW+FQ99qC47LM4CmyvXGrELc91brHeWneT+ct+7HkGbJRvsw6LQucB27Ru341cb9VtBXbQs+rX7ZDd8PisHzW6Xo+1WZDnLxiPuq4f6ay9wfT7tsPMDv3AbrtxONah15nfdv2NoOt5TI84SfXme5qm6bqufUnu9MKIdaw6Jp2I8w6tFeazwHWsVTeMPqysrw/l0ufBTXNfdiMazeYXO0HxBo/L683wfb5pu8Zwaqj1buxH14LA7iGhM6pND1OTCQnaUBwVcVmJ3TbGBQ2gAwxAjsOI8Ruvq0xLojDyT2wvZpQqJhbUxhVF/5W/n7Y0yidUaqu0pVJHpW2VMpXeV+mGSh+o1FXpQ5VuKs8fM59XxaMMPDoI/w9qBDRz1OUkQ4OG7hYz6ZNna/Jgz2Xitt6E96ZZKKATTcdevf4FuK37s1mo9b0fweEumm7slPe7Wtz/zXtQ63uP0smJZuSynwiFDk0ELOD3zj1UaKhpn2QInFC56UfVhXKpEzrdwHNbz4NS4xHhf68ORevyZXvRWbxUWarW2PyVpWbzaXbzd/jt6LEdtp/EBWlU2IdzC2WlEFlXM5lqMlliDFAEjAP2Aw4ADgImAIdgYEQagJo+9EBNZ32y/iTgMOAI4CjgGOA44ATgJOAU4DSgBDjDYZ+eH33BrVdaRbYlVqcAZwHTgBnALGAO66o6ArfHCTS8rvIoFrPwJlyWDZu81ym3LeNRzvitFGMDiZUtD7Eu+Yj0yBYM5HLYwY8nvl75fuvzdwd7glQdEwqf/vDt1ZcUxgcUHi+PfPeVstZXJPtTChC8pHBgQEH2wIlvPrtKDg7h0FeYGMKhr3BoCAepYExu9yE0WGRGi224vsa/w5E5qtgBlA1B5U2KASbIESFIvm8gOCoEmnztmBAYouzIcSHAAD8GyAkhyIuznJwUgpx4jZxKmU0Ep1Nmk1dKKbPJomeEQBeWjKksIUDFJ0bw0yTc60shOXvOwRucPckhdB6jaTkqYzQjRxcwmpUjC6M5ObrIoSiPABM/Dv/m7S/e/uStKEuNH5Dv1BVllbe3eXtaJzCf3AvzqWok56W0kpaWpXQhLb0gpdW01JLSWlp6UUoXU9KiNG3KtJPJVZTmTUMkQl5sd1FSSHzFkn/w/hf4KmmYiAAuOnyS/4wZScVEXHBD4WP/J8xIOiaihVvkd97/iP//BRHHAGFtDwAA",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIB5H4XrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
},
{
"id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
"parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW28TRxTeq71OShwghDuYNJcWzBLHDpBKaQGXRqgRskrgJbKm6/UQhqzXsBdUp1JRq/6QVn3vb6j6J/rcX9CXtrTQFubbzphNhMNKTRS60XybOXNmznfOnDOzVlRFUZ7zB288b2kcbjcaV6MoYK0Gc6M4oCu9B7RaLt2hQci6/uLcbKViz9q1yxfn7Uq1tsCH6rEHxUWfxlHgeOVSI255zP2Y9la669Rf9GPPM2GjfJN2aBS69+i6ffN2xLxl1gqcoGfXrzkhve7xUT9qdL0ebdMgzyeYD7rMjwzaXqPGXcelVod84rRZHI50yDXqt5m/FnQ9jxoRJ6nd+FDXdcMw9G/VW70woh27jkE34rxDe4n6NGCuvczC6NPK6upALn0e3DT3ZTei0Wx+sxMUr/O4vNkMP+KbtmsMJwZa78Z+dDUInB4SOqPa5CA1mZCgDcVhEZelmLXRL+gAA2ACchyGzD95XWVaEoWRf+R4MSVEsbCgPqooxh98ftrSMB/QiKORlkZcjbQ1QjVyVyNrGrmnEaaR+xpZV14+Vj6viUfZ8hgg/D+oEdDMEcZJhiYJ2Qa1yKN/1+TBnsnEbbUJ7y2rUMBLNAN79eYX4LbuT2eh1vd+CIe7aIa5U97vanH/N+9Bre89SicnmpnLfiIUOiQR0IDfO3dQoaGuf5EhcELlhh9V58qlTuh2A4+1XgalxiPC/14fitalS868O3+xslCt0dnLC83m4+zmb/Hb0aM7bD+JC9KosA/nFspKUWVdTWWqyWSJEUARMArYDzgAOAgYAxyCgSFpAGrGwAM1nfXJ+uOAw4AjgKOAY4DjgBOAk4BTgNOAEuAMh31GfniTW6+1imxLrE4A3gZMAqYA04AZrKsZCNweJ9DgusqjWKzCO3BZNmzyXqfctoyHOeN3U4xNJFa2PMS66mdqT92AgVwOO/hwcein75SVK5+Pfb/088bXH8i3ilQd2aLw5S8/9hXVUaGQnrlJYf8rFDaZOPAKExgAjv3w1RX14AAOfYWxARz6CocGcJAK5vh2H0Jbi8xs0TXm6/w7HJmjiR1A2aiovHHRwYB6RAiS7xsIjgqBLqcdEwJTlJ16XAjQwY8B9YQQ5MVZrp4UgpyYpp5KmU0Ep1NmkymllNlk0TNCYAhL5kSWEKDiEyP4aRLu9aWQnD1n4Q3OnuQQOofepOyV0ZuSvfPoTcuejd6M7F3gUJRHgIUfh//w9jdvf/FWlKXGD8j364qyzNt7vD2uqzCf3AuzqWpUz0lpJS0tS+lcWnpeSqtpqS2ltbT0gpTOp6RFadqSaSeTqyjNW6ZIhLzY7qKkkPiKJZ/x9xP4KmlYiAAuOnyS/44RScVCXHBD4WP/N4xIOhaihVvkKX//iv9fAChNaqptDwAA",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAkOtRuH5VwUAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIDAHoXrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
}
]
}
Update the object
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
parent |
optional |
string (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 |
object |
Children of the object |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"parent" : "02dc3da7-600a-494d-9b2b-e72b74143062",
"type": "Wall",
"attributes": {
"element": {
"isparent": true,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"quantity": {
"width": 115
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
Status: 200 OK
Create a new attachment in the object
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>attachments
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments
JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
objectIds |
will be ignored |
string |
The id of the project objects to which the file has to be attached |
fileName |
will be ignored |
string |
Name of the file to be attached to the project |
type |
will be ignored |
string |
Mime type |
size |
will be ignored |
integer |
Size of the file to be attached to the project |
| createdAt | will be ignored | string | Creation date of the attachment |
| creator | will be ignored | object | The user who created the attachment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 201 Created
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Get the attachment list from the object
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>attachments
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Delete all the attachments from the object
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Delete the object
URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>
Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[3]
0: {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
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
Element type describes the type of predefined building elements required to build a building (eg: wall, window, door etc) Each element type have an unique id. Please see the detailed structure of the ElementType in the Object Model
The available element types can be found under 2.1.4.1 Bimplus Element Types
Get the element types
URL: https://api.bimplus.net/v2/<team_slug>/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
URL: https://api.bimplus.net/v2/<team_slug>/element-types/<element_id>
Example: https://api.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9
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 layers
URL: https://api.bimplus.net/v2/<team_slug>/element-types/disciplines
Example: https://api.bimplus.net/v2/bimplus/element-types/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"
}
}
...
Model Service
Not used in the current edition!
A Model is basically a technical building plan which could be created or imported.
Attachment Service
Attachments are mostly documents or any media files with additional information which can be assigned to any project, object or issue. Please see the detailed structure of the attachment in the Object Model
- Please use the Bimplus Project Service for creating an attachment or for getting/deleting all the attachments of a project
- Please use the Bimplus Object Service for creating an attachment or for getting/deleting all the attachments of an object
- Please use the Bimplus Issue Service for creating an attachment or for getting/deleting all the attachments of an issue
Get Attachment information
URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>
Example: https://api.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Download the attachment
URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>/download
Example: https://api.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Update the attachment
URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>
Example:
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 |
integer |
Size of the file to be attached to the project |
| createdAt | will be ignored | string | Creation date of the attachment |
| creator | will be ignored | object | The user who created the attachment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Delete the Attachment
URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>
Example: https://api.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Issue Service
Issues are problems or remarks which can be assigned to any project. Comments or attachments can be added to the issue. Please see the detailed structure of the issue in the Object Model
- Please use the Bimplus Project Service for creating/deleting an issue or for getting all the issues assigned to a project
Get details of the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>
Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3
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"
}
Get all the issue types (Not implemented)
URL: https://api.bimplus.net/v2/<team_slug>/issues/types
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get details of the issue type (Not implemented)
URL: https://api.bimplus.net/v2/<team_slug>/issues/types/<type_id>
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new pin for the issue
URL: https://api.bimplus.net/v2//issues//pins
Example: https://api.bimplus.net/v2//issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
issueId |
will be ignored |
string (guid) |
The id of the issue to which the pin is related |
objectId |
mandatory |
string (guid) |
The id of the object to which the pin is related |
topologyNodeId |
will be ignored |
string (guid) |
The id of the topology to which the pin is attached |
position |
optional |
object |
The position of the issue in the building (x,y,z co-ordinates) |
normalVector |
optional |
object |
The direction of the issue in the 3D space (x,y,z co-ordinates) |
createdAt |
will be ignored |
date |
Creation date of the pin |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"position": {
"x": "123.45",
"y": "234.56",
"z": "345.67"
},
"normalVector": {
"x": "0",
"y": "1",
"z": "2"
}
}
Status: 201 Created
{
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
"position": {
"x": "123.45",
"y": "234.56",
"z": "345.67"
},
"normalVector": {
"x": "0",
"y": "1",
"z": "2"
},
"createdAt": "2013-06-07T10:07:00+00:00",
"id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}
Get all the pins of the issue
URL: https://api.bimplus.net/v2//issues//pins
Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "00000000-0000-0000-0000-000000000000",
"topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
"position": {
"x": 123.45,
"y": 234.56,
"z": 345.67
},
"normalVector": {
"x": 0,
"y": 1,
"z": 2
},
"createdAt": "2013-06-07T10:07:00",
"id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}
]
Delete all the pins from the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/pins
Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new comment for the issue
Resource: issues/<issue_id>/comments
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments
Example: https://api.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| issueId | will be ignored | string(guid) | The id of the issue |
text |
mandatory |
string |
The comment text |
createdAt |
will be ignored |
string (date) |
Creation date of the comment |
| modifiedAt | will be ignored | string (date) | Modified date of the comment |
author |
will be ignored |
object |
The author of the comment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"text": "The fire exit should be x:120, y: 120; z: 340"
}
Status: 201 Created
{
"issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
"text": "The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-07-02T13:26:18.8932853+00:00",
"author": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "",
"firstname": "Unknown",
"lastname": "User",
"company": "",
"fullname": "Unknown User",
"displayname": "Unknown User",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
Get all the comments of the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments
Example: https://api.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
"text": "The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-07-02T13:26:18+00:00",
"modifiedAt": "2013-07-03T13:26:18+00:00",
"author": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "",
"firstname": "Unknown",
"lastname": "User",
"company": "",
"fullname": "Unknown User",
"displayname": "Unknown User",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
]
Delete all the comments from the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments
Example: https://api.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new attachment for the issue
URL: https://api.bimplus.net/v2//issues//attachments
Example:https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments
JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
objectIds |
will be ignored |
string |
The id of the project objects to which the file has to be attached |
fileName |
will be ignored |
string |
Name of the file to be attached to the project |
type |
will be ignored |
string |
Mime type |
size |
will be ignored |
integer |
Size of the file to be attached to the project |
| createdAt | will be ignored | string | Creation date of the attachment |
| creator | will be ignored | object | The user who created the attachment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 201 Created
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Get the attachment list from the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/attachments
Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}
Delete all the attachments from the issue
URL: https://api.bimplus.net/v2//issues//attachments
Example:https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Update the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>
Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| shortId | will be ignored | number | Readable unique issue id |
projectId |
will be ignored |
string (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 |
will be ignored |
string (date) |
Creation date of the issue |
dueDate |
optional |
string (date) |
The date in which the issue is planned to be finished |
solution |
optional |
string |
The proposed solution for the issue |
classification |
optional |
string |
The classification to which the issues belongs |
priority |
optional |
string |
The priority of the issue |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place(x:120, y: 120; z: 340)",
"author": "Mr. Smart",
"status": "open"
}
Status: 200 OK
Delete the issue
URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>
Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Pin Service
Pins are relation between an issue and an object. It defines position of an issue in the 3D space. Please see the detailed structure of the pin in the Object Model
- Please use the Bimplus Issue Service for creating a pin or for getting/deleting all the pins assigned to an issue
Get details of the pin
URL: https://api.bimplus.net/v2//pins/
Example:https://api.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
"position": {
"x": 123.45,
"y": 234.56,
"z": 345.67
},
"normalVector": {
"x": 0,
"y": 1,
"z": 2
},
"createdAt": "2013-06-07T10:07:00",
"id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}
Update the pin
URL: https://api.bimplus.net/v2//pins/
Example: https://api.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
issueId |
mandatory |
string (guid) |
The id of the issue to which the pin is related |
objectId |
mandatory |
string (guid) |
The id of the object to which the pin is related |
newObjectId |
optional |
string (guid) |
It should be specified when the pin is assigned to another object via update |
topologyNodeId |
optional |
string (guid) |
The id of the topology to which the pin is attached |
position |
optional |
object |
The position of the issue in the building (x,y,z co-ordinates) |
normalVector |
optional |
object |
The direction of the issue in the 3D space (x,y,z co-ordinates) |
createdAt |
will be ignored |
date |
Creation date of the pin |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"position": {
"x": 123.45,
"y": 234.56,
"z": 345.67
},
"normalVector": {
"x": 0,
"y": 1,
"z": 2
}
}
Status: 200 OK
Delete the pin
URL: https://api.bimplus.net/v2//pins/
Example: https://api.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Comment Service
A particular comment belonging to an issue can be modified using the comment service.
- Please use the Bimplus Issue Service for creating a comment or to deal with the group of comments belonging to an issue.
Get details of the comment
URL: https://api.bimplus.net/v2/comments/<comment_id>
Example:https://api.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8ea
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
"text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-11-20T08:17:36+00:00",
"modifiedAt": "2013-11-20T08:17:36+00:00",
"author": {
"id": "132a78a5-b523-4bf2-8382-7098fac3f803",
"email": "test@bimplus.net",
"status": "Active",
"firstname": null,
"lastname": null,
"company": null,
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"id": "db540336-47a3-426e-b3bf-1e532bfac8ea"
}
Update the comment
URL: https://api.bimplus.net/v2/comment/<comment_id>
Example: https://api.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8ea
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| issueId | will be ignored | string(guid) | The id of the issue |
text |
mandatory |
string |
The comment text |
createdAt |
will be ignored |
string (date) |
Creation date of the comment |
| modifiedAt | will be ignored | string (date) | Modified date of the comment |
author |
optional |
object |
The author of the comment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
"text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-11-20T08:17:36+00:00",
"modifiedAt": "2013-11-20T08:17:36+00:00",
"author": {
"id": "132a78a5-b523-4bf2-8382-7098fac3f803"
}
}
Status: 200 OK
Delete the comment
URL: https://api.bimplus.net/v2/comments/<comment_id>
Example: https://api.bimplus.net/v2/bimplus/comments/8836308d-f09f-4bb7-b6d2-354a2db205a6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Import Service
This service is used for replacing existing models inside a project by importing the models in the form of IFC and SketchUp files. So, for using this service the model should exist first (which could be either created through the Model Service or the Bimplus portal)
Replace a model by importing SketchUp and IFC files
URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/model/<model_id>/import
Example: https://api.bimplus.net/v2/bimplus/projects/best-project/model/12345/import
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 201 Created
Authorization Service
Authorizes a user and returns a token for further API calls
URL: https://api.bimplus.net/v2/authorize
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
user_id |
mandatory |
string |
The email address of the user |
password |
mandatory |
string |
The user's password |
client_id |
optional |
string |
The identifier of the used client |
application_id |
optional |
string |
The id of the application |
Please, use the client_id from the request and regenerate the token (using the same API call with client_id as the additional parameter) for having the possibility to login multiple times at the same time. For more information, see here
Content-Type: application/json
{
"user_id" : "test@bimplus.net",
"password" : "test"
}
Status: 200 OK
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}
Get token information
Resource: authorize
URL: https://api.bimplus.net/v2/authorize
Content-Type: application/json Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Status: 200 OK
{
"user_id": "b37b60d4-0f1b-4158-99c4-847254786517",
"audience": "00000000-0000-0000-0000-000000000000",
"expires_in": 2271650
}
where,
Name |
Type | Description |
|---|---|---|
user_id |
string | The unique user id to be used for any further API calls. |
expires_in |
string | The remaining lifetime on the access token in seconds |
audience |
string | In our case the id of the client (Mobile app, Browser …) |
Request a cross token
URL: https://api.bimplus.net/v2/cross-token
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
cross_token: "b392cee4d0044ef681fa911772668cf9"
expires_in: 299
token_type: "BimPlus"
}
where,
Name |
Type |
Description |
|---|---|---|
cross_token |
string |
The temporary token which will be used for cross-authenticate |
expires_in |
string |
The remaining lifetime on the access token in seconds |
token_type |
string |
Type of the token which will be used as part of the header |
Cross Authenticate by using cross token
Resource: cross-authorize
URL: https://api.bimplus.net/v2/cross-authorize
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
cross_token |
mandatory |
string |
The temporary token which will be used for cross-authenticate |
client_id |
optional |
string |
The identifier of the used client |
team_id |
optional |
string |
The id of the team |
project_id |
optional |
string |
The id of the project |
application_id |
optional |
string |
The id of the application |
The team_id and project_id information can be provided as part of the call, if the user wants to work on or display(viewer) a particular team or an project.
Content-Type: application/json
{
"cross_token": "b392cee4d0044ef681fa911772668cf9"
}
Status: 200 OK
{
"access_token": "43796fab76d54d2c9cb9120fd7d79c9e",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}
Revoke / Expire the token
URL: https://api.bimplus.net/v2/authorize
Content-Type: application/json Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Status: 200 OK
User Management Service
Create a new user
URL: https://api.bimplus.net/v2/users
Example: https://api.bimplus.net/v2/users
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
mandatory |
string |
Email of the user |
|
status |
optional |
will be ignored |
The status of the account (Active / Inactive) |
password |
mandatory |
string |
Password of the user |
| firstname | optional | string | First name of the user |
| lastname | optional | string | Last name of the user |
| company | optional | string | Company of the user |
| displayname | optional | string | Display name of the user |
| info | optional | string | Information of the user |
| gender | optional | string | Gender of the user |
| phoneWork | optional | string | Office phone number of the user |
| phoneHome | optional | string | Home phone number of the user |
| fax | optional | string | Fax number of the user |
| mobile | optional | string | Mobile number of the user |
| birthDate | optional | string | Birth date of the user |
| address | optional | object | Address of the user |
| street | optional | string | Street name of the user |
| streetNr | optional | string | Street number of the user |
| zip | optional | string | Zip code |
| city | optional | string | City name of the user |
| country | optional | string | Country name of the user |
| preferredLanguage | optional | string | Preferred language of the user (will be set in the portal) |
| teams | will be ignored | array | Team list of the user |
| team | will be ignored | object | Information about an user's team (See the team service) |
| projects | will be ignored | array | Project list of the user |
| project | will be ignored | object | Information about an user's project (See the project service) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"email" : "test@bimplus.net",
"password" : "test"
}
Status: 201 Created
{
"projects": [],
"teams": [],
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active",
"firstname": "",
"lastname": "",
"company": "",
"displayname": "",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": ""
}
Get information about the user
URL: https://api.bimplus.net/v2/users/<user_id>
Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"projects": [],
"teams": [],
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active",
"firstname": "",
"lastname": "",
"company": "",
"displayname": "",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": ""
}
Update information about the user
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 |
|---|---|---|---|
mandatory |
string |
Email of the user |
|
status |
mandatory |
string |
The status of the account (Active / Inactive) |
password |
mandatory |
string |
Password of the user |
| firstname | optional | string | First name of the user |
| lastname | optional | string | Last name of the user |
| company | optional | string | Company of the user |
| displayname | optional | string | Display name of the user |
| info | optional | string | Information of the user |
| gender | optional | string | Gender of the user |
| phoneWork | optional | string | Office phone number of the user |
| phoneHome | optional | string | Home phone number of the user |
| fax | optional | string | Fax number of the user |
| mobile | optional | string | Mobile number of the user |
| birthDate | optional | string | Birth date of the user |
| address | optional | object | Address of the user |
| street | optional | string | Street name of the user |
| streetNr | optional | string | Street number of the user |
| zip | optional | string | Zip code |
| city | optional | string | City name of the user |
| country | optional | string | Country name of the user |
| preferredLanguage | optional | string | Preferred language of the user (will be set in the portal) |
| teams | will be ignored | array | Team list of the user |
| team | will be ignored | object | Information about an user's team (See the team service) |
| projects | will be ignored | array | Project list of the user |
| project | will be ignored | object | Information about an user's project (See the project service) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"email": "updated_test@bimplus.net",
"status": "Active",
"password": "test"
}
Status: 200 OK
Delete the user
URL: https://api.bimplus.net/v2/users/<user_id>
Example: https://api.bimplus.net/v2/users/08b8195a-a2ad-11e2-9993-002215ea7d6b
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get information about the currently logged in user
URL: https://api.bimplus.net/v2/user
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"projects": [],
"teams": [],
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active",
"firstname": "",
"lastname": "",
"company": "",
"displayname": "",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": ""
}
Team Management Service
Create a new team and its related database
URL: https://api.bimplus.net/v2/teams
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
slug |
mandatory |
string |
The unique name which will be used in the url |
name |
mandatory |
string |
Name of the team |
| displayname | mandatory | string | The name of the team which will be displayed in the client |
owner |
mandatory |
string (guid) |
The unique identifier of the user who will be the initial owner |
totalStorage |
mandatory |
integer |
The total storage allocated to the the team (the initial storage size as ordered in the shop) |
storageStats |
will be ignored |
integer |
The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers) |
status |
will be ignored |
string |
Active / Inactive |
teamWorksConnection |
optional |
string |
Base64 encoded database connection string for legacy applications |
dataStorageStatus |
optional |
string |
Online / Offline |
| haswriteaccess | will be ignored | boolean | Write access to the team |
| public | optional | object | Public read/write rights |
| read | optional | boolean | Read right (viewer right to all the projects under this team to all the registered users) |
| write | optional | boolean | Write right (write right to all the projects under this team to all the registered users) |
| rights | object | object | Project rights |
| projectCreate | will be ignored | boolean | The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"slug": "best-company",
"name": "Best Company",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000000,
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online",
"haswriteaccess": false
}
Status: 201 Created
{
"id": "db038754-2598-4616-9ea2-2c0947f2e93a",
"slug": "best-company",
"name": "Best Company",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000000,
"storageStats": {
"usedSpace": 0,
"numberOfProjects": 0,
"numberOfMembers": 0,
"totalSpace": 500000000,
"totalNumberOfProjects": 0,
"totalNumberOfMembers": 0
},
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online",
"haswriteaccess": false,
"public": {
"read": false,
"write": false
},
"rights": {
"projectCreate": true
}
}
Get information about the team
URL: https://api.bimplus.net/v2/teams/<team_slug>
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"id": "db038754-2598-4616-9ea2-2c0947f2e93a",
"slug": "best-company",
"name": "Best Company",
"displayname": "Best Company (best-company)",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000000,
"storageStats": {
"usedSpace": 0,
"numberOfProjects": 0,
"numberOfMembers": 0,
"totalSpace": 500000000,
"totalNumberOfProjects": 0,
"totalNumberOfMembers": 0
},
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online",
"public": {
"read": false,
"write": false
},
"rights": {
"projectCreate": true
}
}
Update information about the team
URL: https://api.bimplus.net/v2/teams/<team_slug>
Example: https://api.bimplus.net/v2/teams/best-company
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
slug |
will be ignored |
string |
The unique name which will be used in the url |
name |
mandatory |
string |
Name of the team |
owner |
will be ignored |
string (guid) |
The unique identifier of the user who will be the initial owner |
totalStorage |
mandatory |
integer |
The total storage allocated to the the team (the initial storage size as ordered in the shop) |
storageStats |
will be ignored |
integer |
The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers) |
status |
mandatory |
string |
Active / Inactive |
teamWorksConnection |
will be ignored |
string |
Base64 encoded database connection string for legacy applications |
dataStorageStatus |
will be ignored |
string |
Online / Offline |
| haswriteaccess | will be ignored | boolean | Write access to the team |
| public | optional | object | Public read/write rights |
| read | optional | boolean | Read right (viewer right to all the projects under this team to all the registered users) |
| write | optional | boolean | Write right (write right to all the projects under this team to all the registered users) |
| rights | object | object | Project rights |
| projectCreate | will be ignored | boolean | The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "Best Company",
"totalStorage": 500000000,
"status": "Active"
}
Status: 200 OK
Delete the team
URL: https://api.bimplus.net/v2/teams/<team_id>
Example: https://api.bimplus.net/v2/teams/08b8195a-a2ad-11e2-9993-002215ea7d6b
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get the team list in which the current logged in user is a member of
URL: https://api.bimplus.net/v2/teams
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": "db038754-2598-4616-9ea2-2c0947f2e93a",
"slug": "best-company",
"name": "Best Company",
"displayname": "Best Company (best-company)",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000000,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online",
"ismyteam": true,
"rights": {
"projectCreate": true
}
},
{
"id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
"slug": "nemetschek",
"name": "Nemetschek",
"displayname": "Nemetschek (nemetschek)",
"owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
"totalStorage": 0,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
"dataStorageStatus": "Online",
"ismyteam": false,
"rights": {
"projectCreate": false
}
},
{
"id": "7eab1453-a4e7-4d05-983e-031544540e6f",
"slug": "bimplus-demo",
"name": "BimPlusDemo",
"displayname": "BimPlusDemo (bimplus-demo)",
"owner": "5592c628-588e-f5c0-b08b-088d43de9209",
"totalStorage": 53687091200,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
"dataStorageStatus": "Online",
"ismyteam": false,
"rights": {
"projectCreate": false
}
}
]
Membership Management Service
Add the user to the team
Resource: <team_slug>/members
URL: https://api.bimplus.net/v2/<team_slug>/members
Example: https://api.bimplus.net/v2/best-company/members
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
user |
mandatory |
object |
Information of the user |
user.id |
mandatory |
string |
Id of the user |
user.email |
will be ignored |
string |
Email of the user |
user.status |
will be ignored |
string |
Status of the user(Active / Inactive) |
roles |
will be ignored |
object |
Roles of the user |
member_status |
optional |
string |
Status of the membership(Active / Passive) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
},
"roles": [
"Member"
],
"member_status": "Active"
}
Status: 200 Ok
Get the member list of the team
URL: https://api.bimplus.net/v2/<team_slug>/members
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active"
},
"roles": [
"Member"
],
"status": "Active"
},
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7",
"email": "customer@bimplus.net",
"status": "Active"
},
"roles": [
"Member"
],
"status": "Passive"
}
]
Update information about the user in the team
URL: https://api.bimplus.net/v2//members/
Example: https://api.bimplus.net/v2/best-company]>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
user |
mandatory |
object |
Information of the user |
user.id |
mandatory |
string |
Id of the user |
status |
mandatory |
string |
Status of the membership(Active / Passive) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"user": {
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
},
"status": "Active"
}
Status: 200 OK
Delete the user from the team
URL: https://api.bimplus.net/v2//members/
Example: https://api.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Rights & Roles Service
Get all the available roles
URL: https://api.bimplus.net/v2/<team_slug>/roles
Example: https://api.bimplus.net/v2/best-company/roles
Get all the available. Right now, we support only project based roles.
Here is the definition of Bimplus Rights & Roles.
| | Account\\
Owner | Project\\
Admin | Project\\
Editor | Project\\
Viewer | Model\\
Admin | Model\\
Editor | Model\\
Viewer |
| Create Project | x | x | | | | | |
| Admin Project (eg. invite) | x | x | | | | | |
| Edit Project | x | x | x | | | | |
| Delete Project | x | x | | | | | |
| View Project | x | x | x | x | x | x | x |
| | | | | | | | |
| View all Models | x | x | x | x | | | |
| Create Model | x | x | x | | | | |
| Admin Model (eg. invite) | x | x | | | | | |
| Assign User to Model | x | x | x | | x | | |
| Edit Model | x | x | x | | x | x | |
| Import Data | x | x | x | | x | x | |
| Delete Model | x | x | x | | x | | |
| View Model | x | x | x | x | x | x | x |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 Ok
[
{
"id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Editor",
"customRole": false,
"resources": [
{
"resource": "UserRightProject",
"rights": [
"Project_Edit",
"Project_View",
"Model_ViewAll"
]
}
]
},
{
"id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
"name": "Account_Owner",
"customRole": false,
"resources": [
{
"resource": "UserRightGlobal",
"rights": [
"AllProjects",
"AllModels",
"Project_Create"
]
}
]
},
{
"id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
"name": "Project_Admin",
"customRole": false,
"resources": [
{
"resource": "UserRightProject",
"rights": [
"Project_Admin",
"Project_Edit",
"Project_Delete",
"Project_View",
"Model_ViewAll",
"Model_Create"
]
}
]
},
{
"id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
"name": "Project_Viewer",
"customRole": false,
"resources": [
{
"resource": "UserRightProject",
"rights": [
"Project_View",
"Model_ViewAll"
]
}
]
}
]
Messaging Service
Create a new message for an user
Resource: messages
URL: https://api.bimplus.net/v2/messages
Example: https://api.bimplus.net/v2/messages
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
id |
will be ignored |
string |
Id of the message |
userId |
mandatory |
string |
Id of the user |
source |
mandatory |
string |
Source of the message (eg: Import Service) |
topic |
mandatory |
string |
Topic of the message |
severity |
mandatory |
object |
Severity can be Info, Warning, Error |
returnCode |
mandatory |
string |
Readable return code |
| timestamp | will be ignored | string | Creation date of the message |
| unread | mandatory | boolean | Whether the message was unread |
| additionalData | optional | string | Extra info |
| correlationId | optional | guid | Id of the other related message |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"id": "4633d522-53aa-4d81-90b4-704681e0573d",
"userid": "c7040e44-508a-4d10-88dc-b7c7ace6c650",
"source": "ServiceName",
"topic": "SKETCHUP_JOB",
"severity": "Warn",
"returncode": "FILE_TOO_BIG",
"unread": false,
"timestamp": "2013-11-15T10:55:53"
}
Status: 201 Created
Get the message list of the current user
URL: https://api.bimplus.net/v2/messages
Example: https://api.bimplus.net/v2/messages
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
"userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
"source": "ServiceName2",
"topic": "SKETCHUP_JOB",
"severity": "Info",
"returncode": "FILE_TOO_BIG",
"timestamp": "2013-11-18T14:55:22",
"unread": false,
"additionaldata": null,
"correlationid": null
},
{
"id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
"userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
"source": "ServiceName",
"topic": "IFC_JOB",
"severity": "Info",
"returncode": "OK",
"timestamp": "2013-11-18T14:30:53",
"unread": true,
"additionaldata": null,
"correlationid": null
}
]
Get information about a specified message
URL: https://api.bimplus.net/v2/messages/<message_id>
Example: https://api.bimplus.net/v2/messages/<message_id>
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
"userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
"source": "ServiceName",
"topic": "IFC_JOB",
"severity": "Info",
"returncode": "OK",
"timestamp": "2013-11-18T14:30:53",
"unread": true,
"additionaldata": null,
"correlationid": null
}
Delete the specified message
URL: https://api.bimplus.net/v2/messages/<message_id>
Example: https://api.bimplus.net/v2/messages/<message_id>
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Mark a message as "read"
URL: https://api.bimplus.net/v2/messages/<message_id>/markasread
Example: https://api.bimplus.net/v2/messages/<message_id>/markasread
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Log Service
Get all the log data
Retrieves the whole log information from the beginning of the time.
It is always better to use the other log API call which retrieves the log info between the time interval as this API will cause serious bandwidth usage
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": 853539,
"server": "K2177",
"date": "2013-12-16T10:00:23",
"requestid": "653750b3-a97e-451f-bd01-1a4671344087",
"thread": "51",
"level": "INFO",
"logger": "PerformanceLog.ServiceLog",
"message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
"exception": ""
},
{
"id": 853540,
"server": "K2177",
"date": "2013-12-16T10:00:23",
"requestid": "653750b3-a97e-451f-bd01-1a4671344087",
"thread": "51",
"level": "INFO",
"logger": "PerformanceLog.UserLog",
"message": "User found byId: bestcustomer@bimplus.net",
"exception": ""
},
{
"id": 853541,
"server": "K2177",
"date": "2013-12-16T10:00:23",
"requestid": "653750b3-a97e-451f-bd01-1a4671344087",
"thread": "51",
"level": "INFO",
"logger": "PerformanceLog.ServiceLog",
"message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
"exception": ""
},.....]
Get the log data between the time interval
URL: https://api.bimplus.net/v2/logs/<startDate>/<endDate>
Example: https://api.bimplus.net/v2/logs/20130101/20130102
OR
Retrieves the log information between the mentioned time interval. The time interval could be either date based(eg: between 01.01.2013,02.01.2013) or time based (between 01.01.2013 12:00, 01.01.2013 14:00)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": 853539,
"server": "K2177",
"date": "2013-12-16T10:00:23",
"requestid": "653750b3-a97e-451f-bd01-1a4671344087",
"thread": "51",
"level": "INFO",
"logger": "PerformanceLog.ServiceLog",
"message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
"exception": ""
},
{
"id": 853540,
"server": "K2177",
"date": "2013-12-16T10:00:23",
"requestid": "653750b3-a97e-451f-bd01-1a4671344087",
"thread": "51",
"level": "INFO",
"logger": "PerformanceLog.UserLog",
"message": "User found byId: bestcustomer@bimplus.net",
"exception": ""
},
{
"id": 853541,
"server": "K2177",
"date": "2013-12-16T10:00:23",
"requestid": "653750b3-a97e-451f-bd01-1a4671344087",
"thread": "51",
"level": "INFO",
"logger": "PerformanceLog.ServiceLog",
"message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
"exception": ""
},.....]
