Note |
---|
Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page. |
Composition Setup |
---|
Info | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Developers please | ||||||||||||||
This web page is under construction. The JSON Request and Response (Request and Response tab) for the API calls are not complete. | ||||||||||||||
Note | ||||||||||||||
Please use
|
bim+ Services
- Project Service
- Object Service
- ElementType Service
- Division Service
- Attachment Service
- Issue Service
- Pin Service
- Import Service
(stage version of Shop/Portal) for testing purposes. The production version of the portal is located under |
...
Composition Setup |
---|
...
...
|
Section | ||
---|---|---|
|
...
|
...
...
Deck of Cards | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Resource: projects URL: https://api.bimplus.net/v2/<team>/projects Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new project. |
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}
|
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
...
Get the Project List
...
id | bimGetProjectList |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects URL: https://api.bimplus.net/v2/<team>/projects Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Gets the available project list with main properties. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"id": "586b02be-43b8-4e27-b698-e067e85e38e2",
"name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
"shortDescr": "Hey, i am your favourite test entry",
"thumbnail": null,
"created": "2013-05-01T09:33:18",
"changed": "2013-05-01T09:33:18"
},
{
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "0001-01-01T00:00:00",
"changed": "0001-01-01T00:00:00"
},
{
"id": "4e87944a-a477-4e4c-862e-e723dcb43066",
"name": "UC_Fly-over Kerensheide",
"shortDescr": null,
"thumbnail": null,
"created": "2013-05-10T07:13:38",
"changed": "2013-05-16T07:34:56"
}
]
|
...
Get the Project Properties
...
id | bimGetProjectProp |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id> URL: https://api.bimplus.net/v2/<team>/projects/<project_id> Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2 |
Card | ||
---|---|---|
| ||
Get all the project properties of a project using its id. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
"shortDescr": "Hey, i am your favourite test entry",
"thumbnail": null,
"created": null,
"changed": null,
"disciplines": [
{
"id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "ID_BuildingModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "63b069d2-81df-4418-91de-8a954fa12924",
"name": "ID_DesignModel_Timber",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
"name": "ID_FinishModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
"name": "ID_RoomModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
}
],
"id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}
|
...
Update the project
...
id | bimUpdateProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: projects/<project_id> URL: https://api.bimplus.net/v2/<team>/projects/<project_id> Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing project with a new one. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"shortDescr" : "Updating the project"
}
|
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Create an issue in the project
...
id | bimCreateIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
Resource: projects/<project_id>issues URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/issues Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new issue in a project. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author": "Mr. Smart",
"status": "open",
"createdAt": "2013-06-02T10:05:00",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author": "Mr. Smart",
"status": "open",
"createdAt": "2013-06-02T10:05:00+00:00",
"dueDate": "2013-06-05T10:05:00+00:00",
"solution": null,
"classification": "",
"priority": "very high",
"revision": null,
"id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}
|
...
Get the Issue List from the project
...
id | bimGetIssueList |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>issues URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/issues Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues |
Card | ||
---|---|---|
| ||
Get all the issues assigned to a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Delete all the issues from the project
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Create a new attachment in the project
...
id | bimCreateAttachmentInProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: projects/<project_id>/attachments URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new attachment in a project. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get the Attachment List from the project
...
id | bimGetAttachmentListFromProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/attachments URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments |
Card | ||
---|---|---|
| ||
Get all the attachments belonging to a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Delete all the attachments from the project
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the project topology tree
...
id | bimGetObject5 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/topology URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/topology Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology |
Card | ||
---|---|---|
| ||
Get the project topology tree. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"parent": null,
"name": null,
"type": "Project",
"children": [
{
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": null,
"type": "ID_TopologyDivision",
"children": [],
"id": "195db084-3715-4ebc-b164-3ee47a495b2e"
}
],
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}
|
...
Get the project disciplines
...
id | bimGetProjectDisc |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/disciplines URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/disciplines Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines |
Card | ||
---|---|---|
| ||
Get the disciplines of a project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
"name": "ID_BuildingModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "63b069d2-81df-4418-91de-8a954fa12924",
"name": "ID_DesignModel_Timber",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
"name": "ID_FinishModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
},
{
"id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
"name": "ID_RoomModel",
"divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
"divisionName": null,
"revisions": []
}
]
|
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
- Create a new object
- Get the object tree with full property list whose geometry type is "mesh"(default)
- Get the object with no children and fully property list whose geometry type is "mesh"(default)
- Get the full property list of the object without geometry
- Get the object tree with full property list without geometry (object topology tree)
- Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
- Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
- Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline
- Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline
- Update the object
- Create a new attachment in the object
- Get the attachment list from the object
- Delete all attachments from the project
- Delete the object
...
Create a new object
...
id | bimGetObject1 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: objects URL: https://api.bimplus.net/v2/<team>/objects Example: https://api.bimplus.net/v2/bimplus/objects JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new object |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"type": "Wall",
"attributes": {
"element": {
"isparent": true,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"quantity": {
"width": 115
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"type": "Wall",
"attributes": {
"element": {
"isparent": true,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"quantity": {
"width": 115
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
|
...
Get the object tree with full property list whose geometry type is "mesh"(default)
...
id | bimGetObject2 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id> URL: https://api.bimplus.net/v2/<team>/objects/<object_id> Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75 |
Card | ||
---|---|---|
| ||
Get the object tree with full property list whose geometry type is "mesh"(default) |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|---|
lang | xml |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"type": "Wall",
"attributes": {
"element": {
"isparent": true,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
|
...
Get the full property list of the object without geometry
...
id | bimGetObject4 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/nogeometry URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/nogeometry Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/nogeometry |
Card | ||
---|---|---|
| ||
Get the full property list of the object without geometry |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"type": "Wall",
"attributes": {
"element": {
"isparent": true,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
}
}
}
|
|
Section | ||||||
---|---|---|---|---|---|---|
|
Section | ||||
---|---|---|---|---|
|
Section | ||||||||
---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||
---|---|---|
|
...
Get the object tree with full property list without geometry (object topology tree)
...
id | bimGetObject6 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/topology URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/topology Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/topology |
Card | ||
---|---|---|
| ||
Get the object tree with full property list without geometry. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"parent": null,
"name": "Brickwall",
"type": "Project",
"children": [],
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
}
|
...
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
...
id | bimGetObject7 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/geometries/threejs URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/geometries/threejs Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/threejs |
Card | ||
---|---|---|
| ||
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS". |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"elementsCount": 0,
"viewbox": {
"x": 0,
"y": 0,
"z": 0,
"width": 0,
"height": 0,
"depth": 0
},
"colors": [],
"objects": []
}
|
...
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
...
id | bimGetObject8 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/geometries/meshblob URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/geometries/meshblob Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/meshblob |
Card | ||
---|---|---|
| ||
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)". |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"elementsCount": 1,
"objects": [
{
"id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"parent": "00000000-0000-0000-0000-000000000000",
"type": "Wall",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3XrNpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunTBYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRmzpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQSKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBbDZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+RWOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwBnAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+eSnz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezdPOiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPhr5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhGPdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4cfXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDhNX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRNlL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4wxaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
}
]
}
|
...
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline*
...
id | bimGetObject9 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs Example: http://api.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/threejs |
Card | ||
---|---|---|
| ||
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"elementsCount": 4,
"viewbox": {
"x": 4067.5,
"y": -480,
"z": -4652.5,
"width": 9775,
"height": 600,
"depth": 9695
},
"colors": [
-4272966
],
"objects": [
{
"id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
"parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
8955,
-780,
-9580,
-820,
-780,
-9580,
-820,
-780,
-9500,
8955,
-780,
-9500,
8955,
-180,
-9580,
-820,
-180,
-9580,
-820,
-180,
-9500,
8955,
-180,
-9500
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9775,
"width": 80,
"height": 600,
"volume": 469200000.0000012,
"area": 5865000.000000014
},
"general": {
"name": "<PP>Wall layer"
}
}
},
{
"id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
"parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
-820,
-780,
-9500,
-820,
-780,
115,
-740,
-780,
115,
-740,
-780,
-9500,
-820,
-180,
-9500,
-820,
-180,
115,
-740,
-180,
115,
-740,
-180,
-9500
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9615,
"width": 80,
"height": 600,
"volume": 461520000.0000002,
"area": 5769000.000000003
},
"general": {
"name": "<PP>Wall layer"
}
}
},
{
"id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
"parent": "b62c83db-69ea-485b-9315-26826110e578",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
-820,
-780,
195,
8875,
-780,
195,
8875,
-780,
115,
-820,
-780,
115,
-820,
-180,
195,
8875,
-180,
195,
8875,
-180,
115,
-820,
-180,
115
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9695,
"width": 80,
"height": 600,
"volume": 465359999.99999976,
"area": 5816999.999999998
},
"general": {
"name": "<PP>Wall layer"
}
}
},
{
"id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
"parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
"type": "WallLayer",
"attributes": {
"geometry": {
"threejs": {
"faces": [
1,
2,
1,
0,
3,
1,
5,
6,
7,
4,
1,
4,
7,
3,
0,
1,
5,
4,
0,
1,
1,
6,
5,
1,
2,
1,
7,
6,
2,
3
],
"vertices": [
8955,
-780,
195,
8955,
-780,
-9500,
8875,
-780,
-9500,
8875,
-780,
195,
8955,
-180,
195,
8955,
-180,
-9500,
8875,
-180,
-9500,
8875,
-180,
195
],
"metadata": {
"formatVersion": 3,
"colorid": 0
}
}
},
"quantity": {
"length": 9695,
"width": 80,
"height": 600,
"volume": 465360000.00000006,
"area": 5817000
},
"general": {
"name": "<PP>Wall layer"
}
}
}
]
}
|
...
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline*
...
id | bimGetObject10 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob Example: http://api.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/meshblob |
Card | ||
---|---|---|
| ||
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"elementsCount": 4,
"objects": [
{
"id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
"parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVX624TRxTe2Yu9TkocIIQ7mDSXtpgljh0gldIGXBqhRsiCwJ/Imq7XQ9hmvaZ7QXUqFbXqg7Tq/z5DpT5Ef/cdeuXSdr7tjNkaOazURIGN5tucM2fnfOfsOTNrhSiK8je/cMf1hsrhTqNxNYoCt9VwnSgO2HrvAauWS3dZELpdf3lhvlKx5q3alUuLVqVaW+JT9diD4bLP4iiwvXKpEbc81/mI9da7W8xf9mPPM+CjfJN1WBQ699mWdfNO5Hprbiuwg55Vv2aH7LrHZ/2o0fV6rM2CPH/AeNB1/Uhn7U2m37MdZnboLbvtxuFYh15jftv1N4Ou5zE94iTVGx9omqbruvYtud0LI9ax6ph0Is47tFaZzwLXsdbcMPq4srExlEufB3fNY9mLbDSb3+wGxes8L682ww/5S9szhlNDvXdjP7oaBHYPBZ3RbHqYmSxI0IbhqMjLauy2IRc0gA4wADkOI8afvK8yLYnGyD+0vZhRqphYUBtXFP0P/nza0yifUKmt0pZKHZW2VcpUek+lmyq9r1JXpZ+odEt5fpn5vCouZeDSQfg16BHQzFGXkwwNGrrbzKQP/12TJ3suE7eNJqI3zUIBNzF0vKtXvwF3DH82C7V+9CPY3MXQjd2Kfk+b+/9FD2r96NE6OTGMXPYdodChiYIF/Ny5iw4NNe2LDIkTJjf8qLpQLnVCpxt4but5Umo8I/zv5aloXb5sLzqLlypL1Rqbv7LUbD7K7v42Px09tsv+k7ygjAoHsG+hrRQi+2omU08mS4wBioBxwEHAIcBhwATgCByMSAcw04duqOmqT9afBBwFHAMcB5wAnAScApwGnAGcBZQA5zgc0POj/wnrpV5RbYnXKcCbgGnADGAWMId1VR2J2+cCGt5XeTSLWXgLIcuBl7zfJbcj41HO+O0UYwOFla0OsS75jPTINhzkcniDn098v/rl0R9XPl0e+ek7ZX0F8s/bX79PUKpjwgCKFwzGBwwG7+RgygAuXjA4NGAgXWB64oevVsjhIRz6BhNDOPQNjgzhIA2MyZ0+hAabzGixTdfX+Hc4KkcVbwBtQ9B5k0LABDkmFMn3DRTHhUKTj50QCkO0HTkpFBDwY4CcEoq82MvJaaHIicfImZTbRHE25TZ5pJRymyx6Tih04cmYypICdHziBD9Nwv0+FJK95x1Eg70n2YTOQ5qWUhnSjJQuQJqVkgVpTkoXORTlFmDix+FffDzj4ykfRdlqfIN8r64oa3y8y8ejOoH75FyYT3UjOS+1lbS2LLULae0Fqa2mtZbU1tLai1K7mNIWpWtTlp0srqJ0bxqiEPLidRclhSRWLPmE339HrJKGiQzgoMMn+W+YkVRM5AUnFD72f8WMpGMiWzhFHvP7L/j/H73mm6ltDwAA",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAICF61G4/o3CQAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
},
{
"id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
"parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TiAOEFLumDSXtpgljh0gSGkDhkaoEbJK4CWypuv1ELZZr+leUJ1KoFb9IUW88xuqvvQn9Ln/ofcbnW87Y5YUh5WaKHSj+SbnzNk535w5Z2atEEVRnvEHPZ59KofbjcaVKArcVsN1ojhgq737rFou3WFB6Hb9xbnZSsWatWqXLsxblWptgQ/VYw+Giz6Lo8D2yqVG3PJc5wPWW+1uMH/Rjz3PgI/yTdZhUejcYxvWzduR6624rcAOelb9qh2y6x4f9aNG1+uxNgvy/AXjftf1I52115l+13aY2aEf2m03Dkc69Crz266/HnQ9j+kRJ6neuKZpmq7r2mNyqxdGrGPVMehEnHdoLTOfBa5jrbhh9FFlbW0glz4P7pqvZTei0Wx+tRMUr/O4vN4M3+ebtmsMJwZ678Z+dCUI7B4SOqPZ5CAzmZCgDcNhEZfl2G1DLmgAHWAAchyGjF95XWWaEoWRf2B7MaNUMTGhNqoo+i/8/bSnYT6gUlulLZU6Km2rlKn0rkrXVXpPpa5KP1bphvL8MfN5VTzKlkcH4f9BjYBmjrqcZGjQ0N1kJn3wz5w82DOZuK01sXrTLBTQiaZjr17/Atx2+dNZqPVXP4TDXTTd2KnV72px/7fVg1p/9SidnGhGLvuJUOjQRMECfu/cQYWGmvYwQ+CEyQ0/qs6VS53Q6Qae23oelBqPCP97dShaFy/a8878hcpCtcZmLy00m4+yu7/Fb0eP7bD/JC5Io8J+nFsoK4XIuprKVJPJFCOAImAUcABwEHAIMAY4DAdD0gHM9IEHajrrk/nHAW8AjgCOAo4BjgNOAE4CTgFOA0qAMxz26/nhF5b1Sq/ItsTrBOBNwCRgCjANmMG8qo7A7XECDa6rPIrFLLyFJcuGTd7rlNuW8TBn/HaKsYHEypaHmJd8SnpkEw5yOezgZ2NPl7/f/PI99J9/+82SlAlSdWSLQbono8Lgk8Wh754oq0v/MjjwEoMXXBx8iQsYQBr7+oslcmgAh77B2AAOfYPDAzhIA2N8uw+hrUVmtNi662v8OxyZo4odQNkQVN64EDBAjghF8n0DxVGh0ORrx4TCEGVHjgsFBPwYICeEIi/OcnJSKHLiNXIq5TZRnE65TV4ppdwmk54RCl14MiayhAAVnzjBT5Nwry+F5Ox5B6vB2ZMcQmchTUqpDGlKSucgTUvJgjQjpfMcivIIMPHj8C/e/uTtD96KstT4AfluXVFWeLvM26M6gfvkXphNVSM5K7WVtLYstXNp7Tmpraa1ltTW0trzUjuf0hala1OmnUyuonRvGiIR8mK7i5JCslZM+Tvvf8ZaJQ0TEcBFh0/ynzAiqZiIC24ofOz/iBFJx0S0cIv8xvsf8P/f/WbD220PAAA=",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACA/kbhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAAPwrXo8BcwAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
},
{
"id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
"parent": "b62c83db-69ea-485b-9315-26826110e578",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TkocIIQ7mJBLC2aJYwdIpbSASyNEhKwSeIms6Xo9hCXrNewF1alU1Ko/pFXf+xuq/ok+9xf0pff7fMuMWYwcVmqi0I3mm8yZs3O+c+acmbVCFEX5hz/o8byhcrjbaFyLosBtNVwnigO21nvEquXSPRaEbtdfXpivVKx5q3bl0qJVqdaW+FQ99qC47LM4CmyvXGrELc91brHeWneT+ct+7HkGbJRvsw6LQucB27Ru341cb9VtBXbQs+rX7ZDd8PisHzW6Xo+1WZDnLxiPuq4f6ay9wfT7tsPMDv3AbrtxONah15nfdv2NoOt5TI84SfXme5qm6bqufUnu9MKIdaw6Jp2I8w6tFeazwHWsVTeMPqysrw/l0ufBTXNfdiMazeYXO0HxBo/L683wfb5pu8Zwaqj1buxH14LA7iGhM6pND1OTCQnaUBwVcVmJ3TbGBQ2gAwxAjsOI8Ruvq0xLojDyT2wvZpQqJhbUxhVF/5W/n7Y0yidUaqu0pVJHpW2VMpXeV+mGSh+o1FXpQ5VuKs8fM59XxaMMPDoI/w9qBDRz1OUkQ4OG7hYz6ZNna/Jgz2Xitt6E96ZZKKATTcdevf4FuK37s1mo9b0fweEumm7slPe7Wtz/zXtQ63uP0smJZuSynwiFDk0ELOD3zj1UaKhpn2QInFC56UfVhXKpEzrdwHNbz4NS4xHhf68ORevyZXvRWbxUWarW2PyVpWbzaXbzd/jt6LEdtp/EBWlU2IdzC2WlEFlXM5lqMlliDFAEjAP2Aw4ADgImAIdgYEQagJo+9EBNZ32y/iTgMOAI4CjgGOA44ATgJOAU4DSgBDjDYZ+eH33BrVdaRbYlVqcAZwHTgBnALGAO66o6ArfHCTS8rvIoFrPwJlyWDZu81ym3LeNRzvitFGMDiZUtD7Eu+Yj0yBYM5HLYwY8nvl75fuvzdwd7glQdEwqf/vDt1ZcUxgcUHi+PfPeVstZXJPtTChC8pHBgQEH2wIlvPrtKDg7h0FeYGMKhr3BoCAepYExu9yE0WGRGi224vsa/w5E5qtgBlA1B5U2KASbIESFIvm8gOCoEmnztmBAYouzIcSHAAD8GyAkhyIuznJwUgpx4jZxKmU0Ep1Nmk1dKKbPJomeEQBeWjKksIUDFJ0bw0yTc60shOXvOwRucPckhdB6jaTkqYzQjRxcwmpUjC6M5ObrIoSiPABM/Dv/m7S/e/uStKEuNH5Dv1BVllbe3eXtaJzCf3AvzqWok56W0kpaWpXQhLb0gpdW01JLSWlp6UUoXU9KiNG3KtJPJVZTmTUMkQl5sd1FSSHzFkn/w/hf4KmmYiAAuOnyS/4wZScVEXHBD4WP/J8xIOiaihVvkd97/iP//BRHHAGFtDwAA",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIB5H4XrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
},
{
"id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
"parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
"type": "WallLayer",
"attributes": {
"geometry": {
"compress": true,
"picture": "H4sIAAAAAAAEANVXW28TRxTeq71OShwghDuYNJcWzBLHDpBKaQGXRqgRskrgJbKm6/UQhqzXsBdUp1JRq/6QVn3vb6j6J/rcX9CXtrTQFubbzphNhMNKTRS60XybOXNmznfOnDOzVlRFUZ7zB288b2kcbjcaV6MoYK0Gc6M4oCu9B7RaLt2hQci6/uLcbKViz9q1yxfn7Uq1tsCH6rEHxUWfxlHgeOVSI255zP2Y9la669Rf9GPPM2GjfJN2aBS69+i6ffN2xLxl1gqcoGfXrzkhve7xUT9qdL0ebdMgzyeYD7rMjwzaXqPGXcelVod84rRZHI50yDXqt5m/FnQ9jxoRJ6nd+FDXdcMw9G/VW70woh27jkE34rxDe4n6NGCuvczC6NPK6upALn0e3DT3ZTei0Wx+sxMUr/O4vNkMP+KbtmsMJwZa78Z+dDUInB4SOqPa5CA1mZCgDcVhEZelmLXRL+gAA2ACchyGzD95XWVaEoWRf+R4MSVEsbCgPqooxh98ftrSMB/QiKORlkZcjbQ1QjVyVyNrGrmnEaaR+xpZV14+Vj6viUfZ8hgg/D+oEdDMEcZJhiYJ2Qa1yKN/1+TBnsnEbbUJ7y2rUMBLNAN79eYX4LbuT2eh1vd+CIe7aIa5U97vanH/N+9Bre89SicnmpnLfiIUOiQR0IDfO3dQoaGuf5EhcELlhh9V58qlTuh2A4+1XgalxiPC/14fitalS868O3+xslCt0dnLC83m4+zmb/Hb0aM7bD+JC9KosA/nFspKUWVdTWWqyWSJEUARMArYDzgAOAgYAxyCgSFpAGrGwAM1nfXJ+uOAw4AjgKOAY4DjgBOAk4BTgNOAEuAMh31GfniTW6+1imxLrE4A3gZMAqYA04AZrKsZCNweJ9DgusqjWKzCO3BZNmzyXqfctoyHOeN3U4xNJFa2PMS66mdqT92AgVwOO/hwcein75SVK5+Pfb/088bXH8i3ilQd2aLw5S8/9hXVUaGQnrlJYf8rFDaZOPAKExgAjv3w1RX14AAOfYWxARz6CocGcJAK5vh2H0Jbi8xs0TXm6/w7HJmjiR1A2aiovHHRwYB6RAiS7xsIjgqBLqcdEwJTlJ16XAjQwY8B9YQQ5MVZrp4UgpyYpp5KmU0Ep1NmkymllNlk0TNCYAhL5kSWEKDiEyP4aRLu9aWQnD1n4Q3OnuQQOofepOyV0ZuSvfPoTcuejd6M7F3gUJRHgIUfh//w9jdvf/FWlKXGD8j364qyzNt7vD2uqzCf3AuzqWpUz0lpJS0tS+lcWnpeSqtpqS2ltbT0gpTOp6RFadqSaSeTqyjNW6ZIhLzY7qKkkPiKJZ/x9xP4KmlYiAAuOnyS/44RScVCXHBD4WP/N4xIOhaihVvkKX//iv9fAChNaqptDwAA",
"type": 3,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAkOtRuH5VwUAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIDAHoXrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
}
}
}
]
}
|
...
Update the object*
...
id | bimObjectUpdate |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: objects/<object_id> URL: https://api.bimplus.net/v2/<team>/objects/<object_id> Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75 JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing object with a new one. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"parent" : "02dc3da7-600a-494d-9b2b-e72b74143062",
"type": "Wall",
"attributes": {
"element": {
"isparent": true,
"nr": 0,
"matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
"elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
"divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
},
"general": {
"name": "Brickwall",
"isobjectvalid": true
},
"quantity": {
"width": 115
},
"allplan": {
"allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
"allplan_id": 2065507287,
"allplan_text": "<PP>Wall",
"dateofexport": "2013-05-01T09:32:13"
},
"geometry": {
"mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
}
}
}
|
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Create a new attachment in the object
...
id | bimObjCreateAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: objects/<object_id>attachments URL: https://api.bimplus.net/v2/<team>/objects/<object_id>attachments Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new attachment in a object. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get the attachment list from the object
...
id | bimGetObjAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>attachments URL: https://api.bimplus.net/v2/<team>/objects/<object_id>attachments Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments |
Card | ||
---|---|---|
| ||
Get all the attachments belonging to a specified object. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Delete all the attachments from the project
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Delete the object
...
id | bimObjDelete |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id> URL: https://api.bimplus.net/v2/<team>/objects/<object_id> Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75 |
Card | ||
---|---|---|
| ||
Deletes a specified object. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
- Get all the element types
- Get the element type properties
- Get the list of exisiting disciplines
...
Get the element types
...
id | bimGetElementType |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: element-types URL: https://api.bimplus.net/v2/<team>/element-types Example: https://api.bimplus.net/v2/bimplus/element-types |
Card | ||
---|---|---|
| ||
Gets the list of existing element types. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: [3]
0: {
type: "GeometryObject"
category: "/1/30/4/"
name: "3D object"
ifcType: "ID_IFCBuildingElementProxy"
id: "5a8a8670-cb9f-4f04-a467-04a9e416a6d0"
}-
1: {
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}-
2: {
type: "Column"
category: "/1/10/2/"
name: "Column"
ifcType: "ID_IFCColumn"
id: "2e308afe-d078-4c20-b53c-76b2da66d848"
} |
...
Get the element type properties
...
id | bimGetElementTypeProp |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: element-types/<element_type_id> URL: https://api.bimplus.net/v2/<team>/element-types/<element_id> Example: https://api.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9 |
Card | ||
---|---|---|
| ||
Get the properties of a specified element type. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
} |
...
Get the list of existing disciplines
...
id | bimGetDisciplines |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: element-types/disciplines URL: https://api.bimplus.net/v2/<team>/element-types/disciplines Example: https://api.bimplus.net/v2/bimplus/element-types/disciplines |
Card | ||
---|---|---|
| ||
Gets the list of existing disciplines. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
-e79a4e18-383f-49c4-aabf-e15b27850423: {
category: "/14/"
name: "Airconditionermodel"
ifcType: null
id: "e79a4e18-383f-49c4-aabf-e15b27850423"
}
-63b069d2-81df-4418-91de-8a954fa12924: {
category: "/5/"
name: "Wood Construction Model"
ifcType: null
id: "63b069d2-81df-4418-91de-8a954fa12924"
}
-dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f: {
category: "/4/"
name: "Massiveconstructionmodel"
ifcType: null
id: "dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f"
}
-6a6e4d09-3550-4483-8134-98ac1e6c1afb: {
category: "/60/"
name: "Production model"
ifcType: null
id: "6a6e4d09-3550-4483-8134-98ac1e6c1afb"
}
-09e623d4-1e12-4a77-b358-ea1d0b28e4a7: {
category: "/2/"
name: "Roommodel"
ifcType: null
id: "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
}
-687c6451-3fa1-47e0-9f13-406833bb06f3: {
category: "/13/"
name: "TGA_Wastewatermodel"
ifcType: null
id: "687c6451-3fa1-47e0-9f13-406833bb06f3"
}
} |
...
Note |
---|
Not used in the current edition! |
Attachment Service
...
- Get attachment information
- Download the attachment
- Update the attachment
- Delete the attachment
...
Get Attachment information
...
id | bimGetAttachmentList |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: attachments/<attachment_id> URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id> Example: |
Card | ||
---|---|---|
| ||
Get detailed information about a specified attachment. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Download the attachment
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Update the attachment
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Delete the Attachment
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issue Service
...
- Get details of the issue
- Get all the issue types
- Get details of the issue type
- Create a new pin for the issue
- Get all the pins of the issue
- Delete all the pins from the issue
- Create a new comment for the issue
- Get all the comments of the issue
- Delete the comment
- Create a new attachment for the issue
- Get the attachment list from the issue
- Delete all the attachments from the issue
- Update the issue
- Delete the issue
...
Get details of the issue
...
id | bimGetIssueDetails |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id> URL: https://api.bimplus.net/v2/<team>/issues/<issue_id> Example: |
Card | ||
---|---|---|
| ||
Get details of an issue present in a project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get all the issue types
...
id | bimGetIssueTypest |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/types URL: https://api.bimplus.net/v2/<team>/issues/types Example: https://api.bimplus.net/v2/bimplus/issues/types |
Card | ||
---|---|---|
| ||
Get all the available issue types. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get details of the issue type
...
id | bimGetIssueTypeDetails |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/types/<type_id> URL: https://api.bimplus.net/v2/<team>/issues/types/<type_id> Example: |
Card | ||
---|---|---|
| ||
Get details of a specified issue type. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Create a new pin for the issue
...
id | bimCreatePin |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Resource: issues/<issue_id>/pins URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pin Example: JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new pin for an issue for relating the issue with its object. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get all the pins of the issue
...
id | bimGetAllPins |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/pins URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pins Example: |
Card | ||
---|---|---|
| ||
Get all the pins of a specified issue type. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Delete all the pins from the issue
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Create a new comment for the issue
...
id | bimCreateComment |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: issues/<issue_id>/comments URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments Example: JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new comment for a specified issue. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get all the comments of the issue
...
id | bimGetAllComments |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/comments URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments Example: |
Card | ||
---|---|---|
| ||
Get all the comments of a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Delete the comment
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Create a new attachment for the issue
...
id | bimCreateAttachmentForIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: issues/<issue_id>/attachments URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments Example: JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new attachment for a specified issue. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get the attachment list from the issue
...
id | bimGetAttachmentListFromIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/attachments URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments Example: |
Card | ||
---|---|---|
| ||
Gets the attachment list from a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Delete all the attachments from the issue
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Update the issue
...
id | bimUpdateIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
Resource: issues/<issue_id> URL: https://api.bimplus.net/v2/<team>/issues/<issue_id> Example: JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing issue with a new one. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Delete the issue
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Pin Service
...
- Get details of the pin
- Update the pin
- Delete the pin
...
Get details of the pin
...
id | bimGetPinDetails |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: pins/<pin_id> URL: https://api.bimplus.net/v2/<team>/pins/<pin_id> Example: |
Card | ||
---|---|---|
| ||
Get details of a specified pin. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Update the pin
...
id | bimPinUpdate |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Resource: pins/<pin_id> URL: https://api.bimplus.net/v2/<team>/pins/<pin_id> Example: JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing pin with a new one. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Delete the pin
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Import Service
...
- Create a new project by importing SketchUp and IFC files.
- Create a new sub-project by importing SketchUp and IFC files.
...
Create a new project by importing SketchUp and IFC files
...
id | bimCreateProjectFromIFC |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: import URL: https://api.bimplus.net/v2/<team>/import Example: https://api.bimplus.net/v2/bimplus/import |
Card | ||
---|---|---|
| ||
Create a new project by importing SketchUp and IFC files into the team database. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Create a new sub-project by importing SketchUp and IFC files
...
id | bimCreateSubProjectFromIFC |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/import URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/import Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/import |
Card | ||
---|---|---|
| ||
Create a new sub-project by importing SketchUp and IFC files into the project. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
Authorization Service
...
- Authenticate by requesting and receiving a token
- Get token information
- Revoke / Terminate the token
...
Authenticate by requesting and receiving a token
...
id | bimAuthenticateToken |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: authorize URL: https://api.bimplus.net/v2/authorize |
Card | ||
---|---|---|
| ||
Authenticate by requesting and receiving a token. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"user_id" : "test@bimplus.net",
"password" : "test"
}
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"access_token": "9c1874a62c974dcfa75e0132c423a088"
"expires_in": 2591999
"token_type": "BimPlus"
}
|
...
Get token information
...
id | bimGetTokenInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: tokeninfo?access_token=<token> URL: https://api.bimplus.net/v2/tokeninfo?access_token=<token> Example: |
Card | ||
---|---|---|
| ||
Get information about a specified token. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"user_id": "b37b60d4-0f1b-4158-99c4-847254786517",
"audience": "00000000-0000-0000-0000-000000000000",
"expires_in": 2271650
}
|
...
Revoke / Expire the token
...
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
User Management Service
...
- Create a new user
- Get information about the user
- Update information about the user
- Get information about the currently logged in user
...
Create a new user
...
id | bimCreateUser |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Resource: users URL: https://api.bimplus.net/v2//users JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new user account. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"email" : "test@bimplus.net",
"password" : "test"
}
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active"
}
|
...
Get information about the user
...
id | bimGetUserInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: users/<user_id> URL: https://api.bimplus.net/v2/users/<user_id> Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6 |
Card | ||
---|---|---|
| ||
Get information about a specified user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active"
}
|
...
Update information about the user
...
id | bimUpdateUserInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Resource: users/<user_id> URL: https://api.bimplus.net/v2//users/<user_id> Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6 JSON Structure:
|
Card | ||
---|---|---|
| ||
Update information about a specified user. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Get information about the currently logged in user
...
id | bimGetCurrentUserInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: user URL: https://api.bimplus.net/v2/user |
Card | ||
---|---|---|
| ||
Get information about the currently logged in user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"email": "test@bimplus.net",
"status": "Active"
}
|
Team Management Service
...
- Create a new team and its related database
- Get information about the team
- Update information about the team
- Get the team list in which the current logged in user is a member of
...
Create a new team and its related database
...
id | bimCreateNewTeam |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
Resource: teams URL: https://api.bimplus.net/v2/teams JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new team and its related database. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"slug": "best-company",
"name": "Best Company",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online"
}
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"id": "db038754-2598-4616-9ea2-2c0947f2e93a",
"slug": "best-company",
"name": "Best Company",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000,
"storageStats": {
"usedSpace": 0,
"numberOfProjects": 0,
"numberOfMembers": 0,
"totalSpace": 500000,
"totalNumberOfProjects": 0,
"totalNumberOfMembers": 0
},
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online"
}
|
...
Get information about the team
...
id | bimGetTeamInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: teams/<team_id> URL: https://api.bimplus.net/v2/teams/<team_id> Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a |
Card | ||
---|---|---|
| ||
Get information about a specified team. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Update information about the team
...
id | bimUpdateTeamInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
Resource: teams/<team_id> URL: https://api.bimplus.net/v2/teams/<team_id> Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a JSON Structure:
|
Card | ||
---|---|---|
| ||
Update information about a specified team. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Get the team list in which the current logged in user is a member of
...
id | bimGetTeamFromCurrentUser |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: teams URL: https://api.bimplus.net/v2/teams |
Card | ||
---|---|---|
| ||
Get a team list in which the current logged in user is a member of |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"id": "db038754-2598-4616-9ea2-2c0947f2e93a",
"slug": "best-company",
"name": "Best Company",
"owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
"totalStorage": 500000,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
"dataStorageStatus": "Online"
},
{
"id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
"slug": "nemetschek",
"name": "Nemetschek",
"owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
"totalStorage": 0,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
"dataStorageStatus": "Online"
},
{
"id": "7eab1453-a4e7-4d05-983e-031544540e6f",
"slug": "bimplus-demo",
"name": "BimPlusDemo",
"owner": "5592c628-588e-f5c0-b08b-088d43de9209",
"totalStorage": 53687091200,
"storageStats": null,
"status": "Active",
"teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
"dataStorageStatus": "Online"
}
]
|
Membership Management Service
...
- Add the user to the team
- Get the member list of the team
- Update information about the user in the team
- Delete the user from the team
...
Add the user to the team
...
id | bimAddUserToTeam |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_id>/members URL: https://api.bimplus.net/v2/<team>/<team_id>/members Example: |
Card | ||
---|---|---|
| ||
Add a specified user to a specified team. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 201 Created
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Get the member list of the team
...
id | bimGetMemberListInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_id>/members URL: https://api.bimplus.net/v2/<team>/<team_id>/members Example: |
Card | ||
---|---|---|
| ||
Get information about a specified user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
...
Update information about the user in the team
...
id | bimUpdateUserInfoInTeam |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_id>/members/<user_id> URL: https://api.bimplus.net/v2/<team>/<team_id>/members/<user_id> Example: |
Card | ||
---|---|---|
| ||
Update information about a specified user in a team. |
...
label | Request |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
...
borderColor | Red |
---|---|
lang | xml |
title | JSON |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Delete the user from the team
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|