Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.
Developers please use https://api-stage.bimplus.net/v2 (stage version of Bimplus API) and https://www-stage.bimplus.net/ (stage version of Shop/Portal) for testing purposes. Please use these login details(Login: bimplus, password: Bimplus) if you receive a login dialog before our portal loads. The production version of the portal is located under https://bimplus.net/ and the base url of the API is different for the production version.
Project relevant services
Administration relevant services
Other services
Project Service
- Create a new project
- Get the logged in user's project list
- Get the user's project list from a team
- 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
- Get the spot list from the project
- Create / Upload a thumbnail to the project
- Download the thumbnail
- Get the structure list from the project
- Delete all the structures from the project
- Get the topology of all structures belonging to the project
- Delete the project
Model Service
Object Service
- Create a new object
- Get the object details
- Generate, save & share the view of an object
- Check whether an object has been updated (See only the header info)
- 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
- Get the different properties / structure(normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations
- Update the object
- Create a new comment in the object
- Get all the comments of the object
- Delete all the comments from the object
- Create a new attachment in the object
- Get the attachment list from the object
- Delete all attachments from the object
- Create a new hyperlink for the object
- Get the hyperlink list from the object
- Delete the object
ElementType Service
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
- Working with hyperlinks belonging to an issue
- Update the issue
- Delete the issue
Slideshow Service
- Create a new slideshow
- Get the slideshow list from a project
- Delete all the slideshows from a project
- Get details of the slideshow
- Update the slideshow
- Delete the slideshow
- Create a new slide for a slideshow
- Get the slide list from a slideshow
- Get the details of a slide
- Update the details of a slide
- Delete a slide from a slideshow
- Create a thumbnail for a slideshow
- Download the thumbnail from a slideshow
- Create a thumbnail for a slide
- Download the thumbnail from a slide
- Working with attachments/comments/hyperlinks belonging to a slide
Authorization Service
User Management Service
Team Management Service
Messaging Service
Bimplus Windows Explorer related Services
- Create a new objectview
- Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"
- Get information about an "Object Navigator" item (objectview)
- Get the properties(column names) of the objectview
- Get the required objectview's details from input objectview list reference
- Delete the objectview
- Create a hierarchy
- Create a list of hierarchies
- Create a complete new structure hierarchy
- Get all the user hierarchies using the user & module information
- Get the details of a hierarchy
- Get details about a list of hierarchies
- Delete the hierarchy
- Delete the list of hierarchies
- Delete all the hierarchies filtered by additional info
- Create a property setting
- Get the property setting details
- Update the property setting
- Delete the property setting
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-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>
Example:https://api-stage.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-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>
Example: https://api-stage.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-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>
Example: https://api-stage.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 Object Service or Bimplus Issue Service for creating a comment or to deal with the group of comments belonging to an object, issue or slide.
Get details of the comment
URL: https://api-stage.bimplus.net/v2/<team_slug>/comments/<comment_id>
Example:https://api-stage.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-stage.bimplus.net/v2/<team_slug>/comment/<comment_id>
Example: https://api-stage.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-stage.bimplus.net/v2/<team_slug>/comments/<comment_id>
Example: https://api-stage.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-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/model/<model_id>/importasync
Example: https://api-stage.bimplus.net/v2/bimplus/projects/best-project/model/12345/importasync
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 201 Created
Slideshow Service
A Slideshow is a group of slides(camera snapshots) attached to a project.
Create a new slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows
Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
mandatory |
string |
Name of the slideshow |
| description | optional | string | Description of the slideshow |
| projectId | will be ignored | string | The id of the project to which the slideshow belongs |
| author | will be ignored | object (user) | Information about the user who has created the slideshow |
| created | will be ignored | string (date) | Creation date of the slideshow |
| id | will be ignored | string (id) | Id of the slideshow |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "My first slideshow"
}
Status: 201 Created
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "My first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"created": "2014-03-06T09:43:00.0929712Z",
"id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}
Get the slideshow list from a project
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows
Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "My first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"created": "2014-03-06T09:43:00",
"id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}
]
Delete all the slideshows from a project
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows
Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get details of the slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "My first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"created": "2014-03-03T15:31:14",
"id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Update the slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the slideshow |
| description | optional | string | Description of the slideshow |
| projectId | optional | string | The id of the project to which the slideshow belongs |
| author | will be ignored | object (user) | Information about the user who has created the slideshow |
| created | will be ignored | string (date) | Creation date of the slideshow |
| id | will be ignored | string (id) | Id of the slideshow |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
}
}
Status: 200 OK
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": null,
"firstname": null,
"lastname": null,
"company": null,
"fullname": "",
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"created": "0001-01-01T00:00:00",
"id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Delete the slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows/<slideshow_id>
Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new slide for a slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the slide |
| description | optional | string | Description of the slide |
| slideInfo | optional | string | |
| scene | optional | object | A JSON string which includes viewMode(transparent or not), camera values & positions, related objects, clipping plane, topology & layer details. An example template is specified below. Please remember, the server will process the scene information as a json string and hence the client has to take care on the information that is stored & retrieved. |
| author | will be ignored | object (user) | Information about the user who has created the slide |
| created | will be ignored | string (date) | Creation date of the slide |
| id | will be ignored | string (id) | Id of the slide |
| index | will be ignored | integer | Order of the slides (Starts with 1) |
"scene": {
"viewMode": "transparent",
"camera": {
"fov": 45,
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
},
"quaternion": {
"x": 0.9,
"y": 0.7,
"z": 0.7,
"w": 0.23
},
"target": {
"objectId": "<GUID>",
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
}
}
},
"objects": {
"selected": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"transparent": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"hidden": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
},
"clippingPlane": {
"axis": "x",
"distance": -123.5,
"selected": false
},
"topology": [
[
"<nodeId>",
"<disciplineId>"
],
[
"<nodeId2>",
"<disciplineId2>"
]
],
"layers": [
{
"id": "<GUID>",
"divisionTopologyId": "<GUID>",
"visible": true,
"transparent": false
}
]
}
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "My first slide",
"scene": {
"viewMode": "transparent",
"camera": {
"fov": 45,
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
},
"quaternion": {
"x": 0.9,
"y": 0.7,
"z": 0.7,
"w": 0.23
},
"target": {
"objectId": "<GUID>",
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
}
}
},
"objects": {
"selected": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"transparent": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"hidden": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
},
"clippingPlane": {
"axis": "x",
"distance": -123.5,
"selected": false
},
"topology": [
[
"<nodeId>",
"<disciplineId>"
],
[
"<nodeId2>",
"<disciplineId2>"
]
],
"layers": [
{
"id": "<GUID>",
"divisionTopologyId": "<GUID>",
"visible": true,
"transparent": false
}
]
}
}
Status: 201 Created
{
"name": "My first slide",
"description": null,
"slideInfo": "",
"index": 1,
"scene": {
"viewMode": "transparent",
"camera": {
"fov": 45,
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
},
"quaternion": {
"x": 0.9,
"y": 0.7,
"z": 0.7,
"w": 0.23
},
"target": {
"objectId": "<GUID>",
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
}
}
},
"objects": {
"selected": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"transparent": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"hidden": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
},
"clippingPlane": {
"axis": "x",
"distance": -123.5,
"selected": false
},
"topology": [
[
"<nodeId>",
"<disciplineId>"
],
[
"<nodeId2>",
"<disciplineId2>"
]
],
"layers": [
{
"id": "<GUID>",
"divisionTopologyId": "<GUID>",
"visible": true,
"transparent": false
}
]
},
"created": "2014-03-06T09:52:58.4376633Z",
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Get the slide list from a slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"name": "My first slide",
"description": null,
"slideInfo": "",
"index": 1,
"scene": {
"viewMode": "transparent",
"camera": {
"fov": 45,
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
},
"quaternion": {
"x": 0.9,
"y": 0.7,
"z": 0.7,
"w": 0.23
},
"target": {
"objectId": "<GUID>",
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
}
}
},
"objects": {
"selected": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"transparent": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"hidden": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
},
"clippingPlane": {
"axis": "x",
"distance": -123.5,
"selected": false
},
"topology": [
[
"<nodeId>",
"<disciplineId>"
],
[
"<nodeId2>",
"<disciplineId2>"
]
],
"layers": [
{
"id": "<GUID>",
"divisionTopologyId": "<GUID>",
"visible": true,
"transparent": false
}
]
},
"created": "2014-03-06T09:52:58",
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
]
Get the details of a slide
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slides/60c23ad7-c4b6-4387-b273-1dff2b1dc895
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"name": "My first slide",
"description": null,
"slideInfo": "",
"index": 1,
"scene": {
"viewMode": "transparent",
"camera": {
"fov": 45,
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
},
"quaternion": {
"x": 0.9,
"y": 0.7,
"z": 0.7,
"w": 0.23
},
"target": {
"objectId": "<GUID>",
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
}
}
},
"objects": {
"selected": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"transparent": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"hidden": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
},
"clippingPlane": {
"axis": "x",
"distance": -123.5,
"selected": false
},
"topology": [
[
"<nodeId>",
"<disciplineId>"
],
[
"<nodeId2>",
"<disciplineId2>"
]
],
"layers": [
{
"id": "<GUID>",
"divisionTopologyId": "<GUID>",
"visible": true,
"transparent": false
}
]
},
"created": "2014-03-06T09:52:58",
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Update the details of a slide
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the slideshow |
| description | optional | string | Description of the slideshow |
| projectId | optional | string | The id of the project to which the slideshow belongs |
| author | will be ignored | object (user) | Information about the user who has created the slideshow |
| created | will be ignored | string (date) | Creation date of the slideshow |
| id | will be ignored | string (id) | Id of the slideshow |
| index | optional | integer | Order of the slide (Starts with 1) |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slide",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
}
}
Status: 200 OK
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": null,
"firstname": null,
"lastname": null,
"company": null,
"fullname": "",
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"created": "0001-01-01T00:00:00",
"id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Delete a slide from a slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slides/<slide_id>
Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slides/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a thumbnail for a slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/thumbnail
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 201 Created
{
"fileName": "Slideshow1.png",
"type": "image/png",
"size": 21320,
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Download the thumbnail from a slideshow
URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id>
Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 200 OK
Create a thumbnail for a slide
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>/thumbnail
Example: https://api-stage.bimplus.net/v2/bimplus/slides/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 201 Created
{
"fileName": "Slide1.png",
"type": "image/png",
"size": 21320,
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Download the thumbnail from a slide
URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/>thumbnail_id>
Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status: 200 OK
Working with attachments/comments/hyperlinks belonging to a slide
Please use the Bimplus Object Service for working with attachments, comments or hyperlinks belonging to a slide
Hyperlink Service
A particular hyperlink belonging to an object/slide/issue can be modified using the hyperlink service.
- Please use the Bimplus Object Service for creating a hyperlink or to deal with the group of hyperlinks belonging to an object, issue or slide.
Get details of the hyperlink
URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>
Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"orderNumber": 1,
"name": "My website",
"url": "https://www.bimplus.net/",
"id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
}
Update the hyperlink
URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>
Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
orderNumber |
optional |
integer |
The ordering number of the hyperlink |
name |
optional |
string |
Name of the hyperlink |
url |
optional |
string |
The actual url |
id |
will be ignored |
string (guid) |
Id of the hyperlink |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "My new website",
"url": "https://www-stage.bimplus.net/"
}
Status: 200 OK
Delete the hyperlink
Resource: hyperlink/<hyperlink_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>
Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Structure Service
A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service
Create a new structure in a project
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/structures
Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/structures
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
parentId |
mandatory |
string(guid) |
Parent node id of the structure (for the first structure, projectId is the parentId) |
name |
mandatory |
string |
Name of the structure |
description |
optional |
string |
Description of the structure |
| type | optional | string | Type of the structure (eg: costStructure, specificationStructure) |
| nr | will be ignored | integer | The index of the structure |
| color | optional | integer | Color of the structure |
| id | will be ignored | string(guid) | Unique guid of the structure |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure"
}
Status: 201 Created
{
"parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
Get the structure details
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>
Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"name": "TestStructure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
Create a sub-node under the structure
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>
Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
parentId |
mandatory |
string(guid) |
Parent node id of the structure (the id specified in the resource url) |
name |
mandatory |
string |
Name of the structure |
description |
optional |
string |
Description of the structure |
| type | optional | string | Type of the structure (eg: costStructure, specificationStructure) |
| nr | will be ignored | integer | The index of the structure |
| color | optional | integer | Color of the structure |
| id | will be ignored | string(guid) | Unique guid of the structure |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "Node 1"
}
Status: 201 Created
{
"parentId": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "TopologyStructure",
"nr": 1,
"color": 0,
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
Get the structure topology
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/topology
Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/topology
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"parent": null,
"name": "TestStructure",
"type": "Structure",
"children": [
{
"parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
"name": "Node 1",
"type": "Structure",
"children": [],
"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}
],
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
Assign an object to the latest/last structure node
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/assign/<object_id>
Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
structureId |
will be ignored |
string(guid) |
The id of the last node to which an object will be assigned |
objectId |
will be ignored |
string(guid) |
The id of the object to whom a structure will be assigned |
name |
mandatory |
string |
The name of the structure-object connection |
| nr | will be ignored | integer | The index of the structure-object connection |
| id | will be ignored | string(guid) | Unique guid of the structure-object connection |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "WallConnection"
}
Status: 201 Created
{
"structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
"objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
"name": "WallConnection",
"nr": 1,
"id": "35b986c2-e9cd-482e-9281-6000671a49f0"
}
Update the structure
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>
Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
parentId |
optional |
string(guid) |
Parent node id of the structure (for the first structure, projectId is the parentId) |
name |
optional |
string |
Name of the structure |
description |
optional |
string |
Description of the structure |
| type | optional | string | Type of the structure (eg: costStructure, specificationStructure) |
| nr | optional | integer | The index of the structure |
| color | optional | integer | Color of the structure |
| id | will be ignored | string(guid) | Unique guid of the structure |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "Updated Structure"
}
Status: 200 OK
{
"parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
"name": "Updated Structure",
"description": "FullLifeCycleTest",
"type": "CostStructure",
"nr": 1,
"color": 0,
"id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
Delete the structure
Resource: structures/<structure_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>
Example:https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Clash Service
Clashes could be detected in a project by calling this service. The person who uploaded the model which contains the clash will get a notification along with the clash count after the clash process is completed. This process will be called during model import in the future.
Detect the clashes in a project
URL: https://api-stage.bimplus.net/v2/<team_slug>/services/postprocess
Example:https://api-stage.bimplus.net/v2/bimplus/services/postprocess
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
runAsync |
mandatory |
bool |
True sets the clash process to run asynchronously |
postProcess |
mandatory |
object |
It runs as a windows service in the server |
projectId |
mandatory |
string |
Id of the project |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"runAsync": "True",
"postProcess": {
"projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
}
}
Status: 200 Ok
{
"postProcess": {
"projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
},
"runAsync": false
}
Authorization Service
Authorizes a user and returns a token for further API calls
URL: https://api-stage.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
URL: https://api-stage.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-stage.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
URL: https://api-stage.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-stage.bimplus.net/v2/authorize
Content-Type: application/json Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Status: 200 OK
User Management Service
Please remember that creating/updating/deleting an user is possible only for the clients who has the permission to do it.
Create a new user
URL: https://api-stage.bimplus.net/v2/users
Example: https://api-stage.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-stage.bimplus.net/v2/users/<user_id>
Example: https://api-stage.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-stage.bimplus.net/v2/users/<user_id>
Example: https://api-stage.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-stage.bimplus.net/v2/users/<user_id>
Example: https://api-stage.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-stage.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
Please remember that creating/updating/deleting a team is possible only for the clients who has the permission to do it.
Create a new team and its related database
URL: https://api-stage.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-stage.bimplus.net/v2/teams/<team_slug>
Example: https://api-stage.bimplus.net/v2/teams/best-company
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-stage.bimplus.net/v2/teams/<team_slug>
Example: https://api-stage.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-stage.bimplus.net/v2/teams/<team_id>
Example: https://api-stage.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-stage.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
Please remember that the team owner cannot remove the membership from his own team.
Add the user to the team
URL: https://api-stage.bimplus.net/v2/<team_slug>/members
Example: https://api-stage.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-stage.bimplus.net/v2/<team_slug>/members
Example: https://api-stage.bimplus.net/v2/best-company/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-stage.bimplus.net/v2/<team_slug>/members/<user_id>
Example: https://api-stage.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-stage.bimplus.net/v2/<team_slug>/members/<user_id>
Example: https://api-stage.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-stage.bimplus.net/v2/<team_slug>/roles
Example: https://api-stage.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"
]
}
]
}
]
Make a team member part of a project by assigning a role to him
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members
Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
member |
mandatory |
object |
The member who will be assigned a role to the project |
id |
mandatory |
string (guid) |
Id of the user |
role |
mandatory |
object |
The project role which will be assigned to the team member |
id |
mandatory |
string (guid) |
Id of the role |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"member": {
"id": "bf5b2382-1d14-b8df-8454-947f83b45c25"
},
role: {
id: "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
}
Status: 201 Created
{
"member": {
"id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
"email": "customer@bimplus.net"
},
"role": {
"id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Editor"
}
Get the project members along with their respective roles
Resource: projects/<project_id>/members
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members
Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"member": {
"id": "7aa846f2-6014-f68d-8dd4-4c7941d7cbcc",
"email": "customer1@bimplus.net"
},
"role": {
"id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Editor"
}
},
{
"member": {
"id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
"email": "customer2@bimplus.net"
},
"role": {
"id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Viewer"
}
}
]
Update the project role of a team member
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members
Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
member |
mandatory |
object |
The member who will be assigned a role to the project |
id |
mandatory |
string (guid) |
Id of the user |
role |
mandatory |
object |
The project role which will be assigned to the team member |
id |
mandatory |
string (guid) |
Id of the role |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"member": {
"id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
"email": "customer@bimplus.net"
},
"role": {
"id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
"name": "Project_Viewer"
}
Status: 200 OK
Remove the user from the project
URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members
Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Messaging Service
Create a new message for an user
URL: https://api-stage.bimplus.net/v2/messages
Example: https://api-stage.bimplus.net/v2/messages
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
id |
will be ignored |
string |
Id of the message |
receiver |
mandatory |
object |
receiver user object (contains id & email) |
| sender | optional | object | sender user object (contains id & email) |
| id | mandatory | string(guid) | id of the user |
| mandatory | string | email 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",
"sender": {
"id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer1@bimplus.net"
},
"receiver": {
"id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer2@bimplus.net"
},
"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-stage.bimplus.net/v2/user/<user_id>/messages
Example: https://api-stage.bimplus.net/v2/user/123456789/messages
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
"sender": {
"id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer1@bimplus.net"
},
"receiver": {
"id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer2@bimplus.net"
},
"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",
"sender": {
"id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer1@bimplus.net"
},
"receiver": {
"id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer2@bimplus.net"
},
"source": "ServiceName",
"topic": "IFC_JOB",
"severity": "Info",
"returncode": "OK",
"timestamp": "2013-11-18T14:30:53",
"unread": true,
"additionaldata": null,
"correlationid": null
}
]
Get the message list of all the users
URL: https://api-stage.bimplus.net/v2/user/messages
Example: https://api-stage.bimplus.net/v2/messages
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
"sender": {
"id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer1@bimplus.net"
},
"receiver": {
"id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer2@bimplus.net"
},
"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",
"sender": {
"id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer1@bimplus.net"
},
"receiver": {
"id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer3@bimplus.net"
},
"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-stage.bimplus.net/v2/messages/<message_id>
Example: https://api-stage.bimplus.net/v2/messages/<message_id>
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
"sender": {
"id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer1@bimplus.net"
},
"receiver": {
"id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer2@bimplus.net"
},
"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-stage.bimplus.net/v2/messages/<message_id>
Example: https://api-stage.bimplus.net/v2/messages/<message_id>
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Mark a message as "read"
URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread
Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Filter the messages (eg: Get all the unread messages from a particular user)
URL: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService
Example: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService
where "%26" is the escape character for "&"
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"id": "44ad058b-1f76-4343-bafa-031eb462215c",
"receiver": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer@bimplus.net"
},
"sender": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "testuser1@bimplus.net"
},
"source": "IssueService",
"topic": "ISSUE_DELETED",
"severity": "Info",
"returnCode": "ISSUE_DELETED",
"timestamp": "2014-05-09T09:54:17",
"unread": true,
"correlationId": null
},
{
"id": "0a4c8eab-26af-49ce-9191-049a141ba762",
"receiver": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer@bimplus.net"
},
"sender": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "testuser1@bimplus.net"
},
"source": "IssueService",
"topic": "ISSUE_UPDATED",
"severity": "Info",
"returnCode": "ISSUE_UPDATED",
"timestamp": "2014-04-08T08:54:41",
"unread": true,
"correlationId": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
},
{
"id": "ffd50096-fb82-4029-8d49-06a04e31f02a",
"receiver": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "customer@bimplus.net"
},
"sender": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "testuser2@bimplus.net"
},
"source": "IssueService",
"topic": "ISSUE_DELETED",
"severity": "Info",
"returnCode": "ISSUE_DELETED",
"timestamp": "2014-05-09T09:54:27",
"unread": true,
"correlationId": null
}
]
Log Service
Get all the log data
URL: https://api-stage.bimplus.net/v2/logs
Example: https://api-stage.bimplus.net/v2/logs
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": "",
"userid": "123456789",
"clientid":"987654321",
"executiontime": "1234"
},
{
"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": "",
"userid": "123456789",
"clientid":"987654321",
"executiontime": "1234"
},
{
"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": "",
"userid": "123456789",
"clientid":"987654321",
"executiontime": "1234"
},.....]
Get the log data between the time interval
URL: https://api-stage.bimplus.net/v2/logs/<startDate>/<endDate>
Example: https://api-stage.bimplus.net/v2/logs/20130101/20130102
OR
https://api-stage.bimplus.net/v2/logs/201301011200/201301011400
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": "",
"userid": "123456789",
"clientid":"987654321",
"executiontime": "1234"
},
{
"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": "",
"userid": "123456789",
"clientid":"987654321",
"executiontime": "1234"
},
{
"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": "",
"userid": "123456789",
"clientid":"987654321",
"executiontime": "1234"
},.....]
Bimplus Windows Explorer related Services
Bimplus Windows Explorer is the Windows desktop application AEC professionals and BIM managers use to upload, manage and analyze building information on the Bimplus platform for use by all contributors to your construction project. For more information please see here
Create a new objectview
URL: https://api-stage.bimplus.net/v2/<team_slug>objectlist
Example: https://api-stage.bimplus.net/v2/bimplus/objectlist
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
elementsId |
mandatory |
object |
List of elements id |
| columnsList | mandatory | object | List of columns |
| tableName | mandatory | string | Name of the resource |
| columnName | optional | string | Name of the property |
| freeAttribId | optional | string(guid) | Id of the used free attribute |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"elementsId": [
"8506156B-F965-4D51-9DD1-01D0C300601E",
"CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
"1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
],
"columnsList": [
{
"tableName": "general",
"columnName": "Name",
"freeAttribId": null
},
{
"tableName": "general",
"columnName": "Description",
"freeAttribId": null
},
{
"tableName": "quantity",
"columnName": "Length",
"freeAttribId": null
},
{
"tableName": "quantity",
"columnName": "Height",
"freeAttribId": null
},
{
"tableName": "element",
"columnName": "ElementTyp",
"freeAttribId": null
},
{
"tableName": "element",
"columnName": "DivisionID",
"freeAttribId": null
},
{
"tableName": "stringattrib",
"columnName": "",
"freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
},
{
"tableName": "doubleattrib",
"columnName": "",
"freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
}
]
}
Status: 201 CREATED
{
"elementsId": [
"8506156B-F965-4D51-9DD1-01D0C300601E",
"CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
"1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
],
"columnsList": [
{
"tableName": "general",
"columnName": "Name",
"freeAttribId": null
},
{
"tableName": "general",
"columnName": "Description",
"freeAttribId": null
},
{
"tableName": "quantity",
"columnName": "Length",
"freeAttribId": null
},
{
"tableName": "quantity",
"columnName": "Height",
"freeAttribId": null
},
{
"tableName": "element",
"columnName": "ElementTyp",
"freeAttribId": null
},
{
"tableName": "element",
"columnName": "DivisionID",
"freeAttribId": null
},
{
"tableName": "stringattrib",
"columnName": "",
"freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
},
{
"tableName": "doubleattrib",
"columnName": "",
"freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
}
]
}
Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"
Get information about an "Object Navigator" item (objectview)
Get the properties of the object (objectview)
URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_name>/properties
Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building/properties
Get the properties of a particular objectview
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"name": "ObjectID",
"ordernr": 1,
"datatype": "uniqueidentifier",
"isdefault": null,
"categorynameid": null,
"resourcenameid": null,
"proporder": null,
"converter": null,
"browsable": "false",
"iconid": null,
"filterable": null
},
{
"name": "Nr",
"ordernr": 2,
"datatype": "int",
"isdefault": null,
"categorynameid": "Category.General",
"resourcenameid": null,
"proporder": null,
"converter": null,
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Name",
"ordernr": 3,
"datatype": "nvarchar",
"isdefault": "true",
"categorynameid": "Category.General",
"resourcenameid": "Name",
"proporder": null,
"converter": "Converter_PPName",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Description",
"ordernr": 4,
"datatype": "nvarchar",
"isdefault": "true",
"categorynameid": "Category.General",
"resourcenameid": "Description",
"proporder": null,
"converter": null,
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "DivisionID",
"ordernr": 5,
"datatype": "uniqueidentifier",
"isdefault": null,
"categorynameid": null,
"resourcenameid": null,
"proporder": null,
"converter": null,
"browsable": "false",
"iconid": null,
"filterable": null
},
{
"name": "Division",
"ordernr": 6,
"datatype": "nvarchar",
"isdefault": "true",
"categorynameid": "Category.General",
"resourcenameid": "Property.Model",
"proporder": null,
"converter": null,
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "ModelType",
"ordernr": 7,
"datatype": "uniqueidentifier",
"isdefault": "true",
"categorynameid": "Category.General",
"resourcenameid": "Property.Discipline",
"proporder": null,
"converter": "Converter_ElementType",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "ElementTyp",
"ordernr": 8,
"datatype": "uniqueidentifier",
"isdefault": "true",
"categorynameid": "Category.General",
"resourcenameid": "Type",
"proporder": null,
"converter": "Converter_ElementType",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Weight",
"ordernr": 9,
"datatype": "float",
"isdefault": null,
"categorynameid": "Category.Geometry",
"resourcenameid": "Mass",
"proporder": null,
"converter": "Converter_Mass",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Volume",
"ordernr": 10,
"datatype": "float",
"isdefault": null,
"categorynameid": "Category.Geometry",
"resourcenameid": "Volume",
"proporder": null,
"converter": "Converter_Volume",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Area",
"ordernr": 11,
"datatype": "float",
"isdefault": null,
"categorynameid": "Category.Geometry",
"resourcenameid": "Area",
"proporder": null,
"converter": "Converter_Area",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Length",
"ordernr": 12,
"datatype": "float",
"isdefault": "true",
"categorynameid": "Category.Geometry",
"resourcenameid": "Element.Geometry.Length",
"proporder": null,
"converter": "Converter_Length",
"browsable": null,
"iconid": null,
"filterable": null
},
{
"name": "Width",
"ordernr": 13,
"datatype": "float",
"isdefault": "true",
"categorynameid": "Category.Geometry",
"resourcenameid": "Element.Geometry.Width",
"proporder": null,
"converter": "Converter_Length",
"browsable": null,
"iconid": null,
"filterable": null
}
]
Get the required object's(objectview's) details from input objectview list reference
URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/content
Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/content
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
mandatory |
string |
Name of the resource/objectview |
elementsguid |
optional |
object |
List of object id's whose details has to be found |
| filter | optional | object | The properties that could be used as filters |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"name": "onProjectElements_Building",
"elementsguid": [
"1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
"54978C4C-B18B-4420-819D-405234FC11B4",
"EB0472BE-1353-4E47-BE76-875924E0586F"
],
"filter": [
"ObjectId",
"DivisionId",
"Name",
"Width",
"ElementTyp"
]
}
Status: 200 OK
[
{
"objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
"divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
"name": "Wall",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"width": 300
},
{
"objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
"divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
"name": "Wall",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"width": 300
},
{
"objectid": "eb0472be-1353-4e47-be76-875924e0586f",
"divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
"name": "Wall",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"width": 300
}
]
Delete the object view
URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_id>
Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new hierarchy
URL: https://api-stage.bimplus.net/v2/<team_slug>/hierarchies/<hierarchy_id>
Example: https://api-stage.bimplus.net/v2/bimplus/hierarchies/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| moduleId | mandatory | string(guid) | Guid of the module |
objectId |
mandatory |
string(guid) |
Guid of the object type |
| userId | mandatory | string(guid) | Guid of the user |
| category | optional | string | Name of the category(default is "ObjectNavigator") |
| oneExtendedData | mandatory | object | Additional information |
| valueKey | mandatory | string | key name |
| valueName | mandatory | string | Value of the key |
| value | mandatory | string | Content of stored value |
| isDefault | optional | boolean | Whether it is the default value |
| dataSmallInt | optional | integer | Additional info about the value |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
"moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
"category": "ObjectNavigator",
"oneExtendedData": {
"valueKey": "[onProjectElements_Building]onProjectElements_Building",
"valueName": "test xxx",
"value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
"isDefault": "0",
"dataSmallInt": "1"
}
}
Status: 200 OK
{
"objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
"moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
"category": "ObjectNavigator",
"oneExtendedData": {
"valueKey": "[onProjectElements_Building]onProjectElements_Building",
"valueName": "test xxx",
"value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
"isDefault": "0",
"dataSmallInt": "1"
}
}
Create a list of hierarchies
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=createlist
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=createlist
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| moduleId | mandatory | string(guid) | Guid of the module |
objectId |
mandatory |
string(guid) |
Guid of the object type |
| userId | mandatory | string(guid) | Guid of the user |
| category | optional | string | Name of the category(default is "ObjectNavigator") |
| oneExtendedData | mandatory | object | Additional information |
| valueKey | mandatory | string | key name |
| valueName | mandatory | string | Value of the key |
| value | mandatory | string | Content of stored value |
| isDefault | optional | boolean | Whether it is the default value |
| dataSmallInt | optional | integer | Additional info about the value |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
"moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
"category": "ObjectNavigator",
"extendedDataList": [
{
"userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
"valueKey": "[onProjectElements_Building]onProjectElements_Building",
"valueName": "pokus 001",
"value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
"isDefault": "false",
"dataSmallInt": "1"
},
{
"userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
"valueKey": "[onProjectElements_Building]onProjectElements_Building",
"valueName": "pokus 002",
"value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
"isDefault": "false",
"dataSmallInt": "1"
}
]
}
Status: 200 OK
{
"objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
"moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
"category": "ObjectNavigator",
"extendedDataList": [
{
"userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
"valueKey": "[onProjectElements_Building]onProjectElements_Building",
"valueName": "pokus 001",
"value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
"isDefault": "false",
"dataSmallInt": "1"
},
{
"userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
"valueKey": "[onProjectElements_Building]onProjectElements_Building",
"valueName": "pokus 002",
"value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
"isDefault": "false",
"dataSmallInt": "1"
}
]
}
Create a complete new hierarchy structure
URL: https://api-stage.bimplus.net/v2/<team_slug>/services/applyhierarchy
Example: https://api-stage.bimplus.net/v2/bimplus/services/applyhierarchy
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| projectId | mandatory | string(guid) | Id of the project for which the structure will be created |
userSettingId |
mandatory |
string(guid) |
Id of the user settings required for the hierarchy definition |
| hierarchyDefinition | mandatory | string | Definition of the hierarchy |
| name | mandatory | string | Name of the hierarchy |
| description | optional | string | Description of the hierarchy |
| structureType | optional | string | Structure type |
| elementsId | optional | Array of strings(guid) | List of elements guid connected to the hierarchy structure |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"runAsync": "false",
"applyHierarchy": {
"projectId": "01C52808-6561-47F6-833E-B62D05DA8A8E",
"hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I] tabAttribGeometry.Width[I][8807e401-6e3c-4536-88e1-e834d4de745d].Value",
"name": "Navigator 1",
"description": "Test for HierarchyNavigator",
"structureType": "CostStructure",
"elementsId": [
"803312C0-26B6-49BE-A607-4319F1B32383",
"51FEF0FA-437B-4410-B9BE-39B9E15D440F",
"71D472FD-96A5-4174-8A5A-460DEB8E88E1"
]
}
}
Status: 201 CREATED
{
"applyHierarchy": {
"projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
"hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I]tabAttribGeometry.Width[I] [8807e401-6e3c-4536-88e1-e834d4de745d].Value",
"name": "Navigator 1",
"description": "Test for HierarchyNavigator",
"structureType": "CostStructure",
"elementsId": [
"803312c0-26b6-49be-a607-4319f1b32383",
"51fef0fa-437b-4410-b9be-39b9e15d440f",
"71d472fd-96a5-4174-8a5a-460deb8e88e1"
],
"result": {
"projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
"parentId": "01c52808-6561-47f6-833e-b62d05da8a8e",
"name": "Navigator 1",
"description": "Test for HierarchyNavigator",
"type": "CostStructure",
"nr": 45,
"color": 0,
"id": "dd71620e-af8f-4496-88a5-cc2be1f1747d"
}
},
"runAsync": false
}
Get all the user hierarchies using the user & module information
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchies?moduleId=xxx;userId=yyy;category=zzz
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
moduleid |
mandatory |
guid |
Id of the module |
userid |
mandatory |
guid |
Id of the user |
| category | optional | string | category name (default category is "ObjectNavigator") |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[
{
"attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
"objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
"module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
"category": "ObjectNavigator",
"isdefault": false,
"valuekey": "[onProjectElements_Building]",
"valuename": "onProjectElements_Building",
"value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
"datasmallint": null,
"revision": null
},
{
"attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
"objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
"module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
"category": "ObjectNavigator",
"isdefault": false,
"valuekey": "[onProjectElements_Electricity]",
"valuename": "onProjectElements_Electricity",
"value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
"datasmallint": null,
"revision": null
},
{
"attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
"objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
"module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
"category": "ObjectNavigator",
"isdefault": false,
"valuekey": "[onProjectElements_MEP]",
"valuename": "onProjectElements_MEP",
"value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
"datasmallint": 0,
"revision": null
}
]
Get the details of a hierarchy
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchies/hierarchy_id>
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies/B39AD364-F049-42E3-A936-3FD2871EB4D4
Get information about a particular hierarchy
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"attribusersettingid": "b39ad364-f049-42e3-a936-3fd2871eb4d4",
"objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
"module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
"category": "ObjectNavigator",
"isdefault": false,
"valuekey": "[onProjectElements_Building]onProjectElements_Building",
"valuename": "Hierarchie Nr.1",
"value": "[I]Name[I]Length[F][0]<3000[2]>=215[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND[I]Width[F][0]<1000[2]>400[10]AND[11]AND[12]AND[13]AND[14]AND",
"datasmallint": 1,
"revision": null
}
Get details about a list of hierarchies
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchies?$operation=getlist
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies?$operation=getlist
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
userSettingsListId |
mandatory |
object |
List of hierarchy ids |
Get details about a list of hierarchies
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"userSettingsListId": [
"AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
"AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
]
}
Status: 200 OK
[
{
"attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
"objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
"module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
"category": "ObjectNavigator",
"isdefault": false,
"valuekey": "[onProjectElements_Building]",
"valuename": "onProjectElements_Building",
"value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
"datasmallint": null,
"revision": null
},
{
"attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
"objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
"module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
"userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
"category": "ObjectNavigator",
"isdefault": false,
"valuekey": "[onProjectElements_Electricity]",
"valuename": "onProjectElements_Electricity",
"value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
"datasmallint": null,
"revision": null
}
]
Delete the hierarchy
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies/<hierarchy_id>
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Delete the list of hierarchies
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=deletelist
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=deletelist
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
userSettingsListId |
mandatory |
object |
List of hierarchy ids that has to be deleted |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"userSettingsListId": [
"AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
"AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
]
}
Status: 200 OK
Delete all the hierarchies filtered by additional info
URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?moduleId=<xxx>;userId=<yyy>;category=<name>;objectId=<zzz>
Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator;objectId=1F15C447-E511-4FC1-940B-13639F973C52
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
moduleId |
mandatory |
string(guid) |
Id of the module |
| userId | mandatory | string(guid) | Id of the user |
| objectId | optional | string(guid) | Id of the object (default is "1F15C447-E511-4FC1-940B-13639F973C52") |
| Category | optional | string | Name of the category (default is "ObjectNavigator") |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"userSettingsListId": [
"AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
"AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
]
}
Status: 200 OK
Create a property setting
URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>
Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| attributes | mandatory | object | List of attributes |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"attributes": {
"general": [
"Name",
"Description"
],
"quantity": [
"Length",
"Width",
"Height",
"Volume"
],
"freeattribute": [
"59AB0000-4100-4020-B0D0-01D3EEDF5389",
"CFF9B525-DE61-4E66-A040-BF7437495BEB"
],
"elementstates": [
"State"
]
}
}
Status: 201 CREATED
{
"attributes": {
"general": [
"Name",
"Description"
],
"quantity": [
"Length",
"Width",
"Height",
"Volume"
],
"freeattribute": [
"59AB0000-4100-4020-B0D0-01D3EEDF5389",
"CFF9B525-DE61-4E66-A040-BF7437495BEB"
],
"elementstates": [
"State"
]
}
}
Get the property setting details
URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>
Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/B39AD364-F049-42E3-A936-3FD2871EB4D4
Get information about a particular property setting
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"attributes": {
"general": [
"Name",
"Description"
],
"quantity": [
"Length",
"Width",
"Height",
"Volume"
],
"freeattribute": [
"59AB0000-4100-4020-B0D0-01D3EEDF5389",
"CFF9B525-DE61-4E66-A040-BF7437495BEB"
],
"elementstates": [
"State"
]
}
}
Update the property setting
URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>
Example: https://api-stage.bimplus.net/v2/bimpluspropertysettings/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
attributes |
mandatory |
object |
List of attributes |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"attributes": {
"general": [
"Name",
"Description"
],
"quantity": [
"Length",
"Width",
"Height",
"Volume"
],
"freeattribute": [
"59AB0000-4100-4020-B0D0-01D3EEDF5389",
"CFF9B525-DE61-4E66-A040-BF7437495BEB"
],
"elementstates": [
"State"
]
}
}
Status: 200 OK
Delete the property setting
URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>
Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
