This page is under construction |
Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page. |
Please use for the testing purposes because our productive server is not available to the market yet. |
|
|
|
A Project is basically a building project which can be created or imported into the Bimplus platform using the appropriate Bimplus services.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Objects are the primary component of the project tree and it exists in two forms.
Please see the detailed structure of the issue in the Object Model
|
|
|
|
|
|
|
|
|
|
|
|
|
Element type describes the type of predefined building elements required to build a building (eg: wall, window, door etc) Each element type have an unique id. Please see the detailed structure of the ElementType in the Object Model
The available element types can be found under 2.1.4.1 Bimplus Element Types
|
|
|
Not used in the current edition! |
A Model is basically a technical building plan which could be created or imported.
Attachments are mostly documents or any media files with additional information which can be assigned to any project, object or issue. Please see the detailed structure of the attachment in the Object Model
|
|
|
|
Issues are problems or remarks which can be assigned to any project. Comments or attachments can be added to the issue. Please see the detailed structure of the issue in the Object Model
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
|
|
This service is used for creating a new project by importing the existing projects in the form of IFC and SketchUp files into a team base.
|
|
|
|
|
|
|
|
|
|
|
|
Resource: teams
URL: https://api.bimplus.net/v2/teams
JSON Structure:
Name | Mandatory / Optional | Type | Description |
---|---|---|---|
slug | mandatory | string | The unique name which will be used in the url |
name | mandatory | string | Name of the team |
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 |
status | will be ignored | string | Active / Inactive |
teamWorksConnection | optional | string | Base64 encoded database connection string for legacy applications |
dataStorageStatus | optional | string | Online / Offline |
Create a new team and its related database.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
{ "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000000, "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==", "dataStorageStatus": "Online" } |
Status: 201 Created |
{ "id": "db038754-2598-4616-9ea2-2c0947f2e93a", "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000000, "storageStats": { "usedSpace": 0, "numberOfProjects": 0, "numberOfMembers": 0, "totalSpace": 500000000, "totalNumberOfProjects": 0, "totalNumberOfMembers": 0 }, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==", "dataStorageStatus": "Online" } |
GET
Resource: teams/<team_slug>
URL: https://api.bimplus.net/v2/teams/<team_slug>
Example: https://api.bimplus.net/v2/teams/best-company
Get information about a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
Status: 200 OK |
{ "id": "33b7d02a-8c97-460e-9bf2-4959937fd2c5", "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000000, "storageStats": { "usedSpace": 13369344, "numberOfProjects": 0, "numberOfMembers": 0, "totalSpace": 500000000, "totalNumberOfProjects": 0, "totalNumberOfMembers": 0 }, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcuYmVzdC1jb21wYW55O1VzZXIgSUQ9YmVzdC1jb21wYW55O1Bhc3N3b3JkPWFjNzZmMjM1MzJkMGI5ZjE0ZTYzNmRmMWVmZDAwNmMyMDM2ZGU4NWM7Q29ubmVjdCBUaW1lb3V0PTEw", "dataStorageStatus": "Online" } |
PUT
Resource: teams/<team_slug>
URL: https://api.bimplus.net/v2/teams/<team_slug>
Example: https://api.bimplus.net/v2/teams/best-company
JSON Structure:
Name | Mandatory / Optional | Type | Description |
---|---|---|---|
slug | will be ignored | string | The unique name which will be used in the url |
name | mandatory | string | Name of the team |
owner | will be ignored | string (guid) | The unique identifier of the user who will be the initial owner |
totalStorage | mandatory | integer | The total storage allocated to the the team (the initial storage size as ordered in the shop) |
storageStats | will be ignored | integer | The storage statistics of the team |
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 |
Update information about a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
{ "name": "Best Company", "totalStorage": 500000000, "status": "Active" } |
Status: 200 OK |
DELETE
Resource: teams/<team_slug>
URL: https://api.bimplus.net/v2/teams/<team_id>
Example: https://api.bimplus.net/v2/teams/08b8195a-a2ad-11e2-9993-002215ea7d6b
Delete a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
Status: 200 OK |
GET
Resource: teams
URL: https://api.bimplus.net/v2/teams
Get a team list in which the current logged in user is a member of
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
Status: 200 OK |
[ { "id": "db038754-2598-4616-9ea2-2c0947f2e93a", "slug": "best-company", "name": "Best Company", "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6", "totalStorage": 500000000, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==", "dataStorageStatus": "Online" }, { "id": "82884f54-96bf-4e9c-a2fb-44db8379378d", "slug": "nemetschek", "name": "Nemetschek", "owner": "132a78a5-b523-4bf2-8382-7098fac3f803", "totalStorage": 0, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==", "dataStorageStatus": "Online" }, { "id": "7eab1453-a4e7-4d05-983e-031544540e6f", "slug": "bimplus-demo", "name": "BimPlusDemo", "owner": "5592c628-588e-f5c0-b08b-088d43de9209", "totalStorage": 53687091200, "storageStats": null, "status": "Active", "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=", "dataStorageStatus": "Online" } ] |
POST
Resource: <team_slug>/members
URL: https://api.bimplus.net/v2/<team_slug>/members
Example: https://api.bimplus.net/v2/best-company/members
JSON Structure:
Name | Mandatory / Optional | Type | Description |
---|---|---|---|
user | mandatory | object | Information of the user |
user.id | mandatory | string | Id of the user |
user.email | will be ignored | string | Email of the user |
user.status | will be ignored | string | Status of the user(Active / Inactive) |
roles | will be ignored | object | Roles of the user |
status | mandatory | string | Status of the membership(Active / Passive) |
Add a specified user to a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
{ "user": { "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6" }, "roles": [ "Member" ], "status": "Active" } |
Status: 200 Ok |
GET
Resource: <team_slug>/members
URL: https://api.bimplus.net/v2/<team_slug>/members
Example: https://api.bimplus.net/v2/best-company/members
Gets the member list of a specified team.
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" } ] |
PUT
Resource: <team_slug>/members/<user_id>
URL: https://api.bimplus.net/v2//members/
Example: https://api.bimplus.net/v2/best-company]>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
JSON Structure:
Name | Mandatory / Optional | Type | Description |
---|---|---|---|
user | mandatory | object | Information of the user |
user.id | mandatory | string | Id of the user |
status | mandatory | string | Status of the membership(Active / Passive) |
Update information about a specified user in a team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
{ "user": { "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7" }, "status": "Active" } |
Status: 200 OK |
DELETE
Resource: <team_slug>/members/<user_id>
URL: https://api.bimplus.net/v2//members/
Example: https://api.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6
Deletes a specified user from a team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json |
Status: 200 OK |