Note |
---|
This web page is under construction. The JSON Request and Reply (Request and Reply tab) for the API calls are not complete. |
Bim+ Services
- Project Service
- Object Service
- ElementType Service
- Division Service
- Attachment Service
- Issue Service
- Pin Service
- Import Service
...
Project Service
...
- Create a new project
- Get the project list
- Get the properties of the project
- Update the project
- Create an issue in the project
- Get the issue list from the project
- Delete all the issues from the project
- Create a new attachment in the project
- Get the attachment list from the project
- Delete all the attachments from the project
- Get the project disciplines
- Delete the project
...
Create a new project
...
id | bimCreateProject |
---|
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/c8c8e6f2-4495-484c-929d-0049f1f9d4ff |
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"
}
|
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 use
|
Section | ||||
---|---|---|---|---|
| ||||
|
Section | ||||||
---|---|---|---|---|---|---|
|
Section | ||||
---|---|---|---|---|
|
Section | ||||||||
---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||
---|---|---|
|
...
Update the project
...
id | bimUpdateProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Resource: projects/<project_id> URL: https://api.bimplus.net/v2/<company>/projects/<project_id> Example: https://api.bimplus.net/v2/bimplus/projects 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/<company>/projects/<project_id>/issues Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new issue in a project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the Issue List from the project
...
id | bimGetIssueList |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>issues URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/issues Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get all the issues assigned to a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete all the issues from the project
...
id | bimDeleteIssueList |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>issues |
Card | ||
---|---|---|
| ||
Delete all the issues belonging to a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Create a new attachment in the project
...
id | bimCreateAttachmentInProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: projects/<project_id>/attachments URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new attachment in a project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the Attachment List from the project
...
id | bimGetAttachmentListFromProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/attachments URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get all the attachments belonging to a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete all the attachments from the project
...
id | bimDeleteAttachmentListFromProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/attachments URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Delete all the attachments belonging to a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the project disciplines
...
id | bimGetProjectDisc |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/disciplines URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/disciplines Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get the disciplines of a project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the project
...
id | bimDeleteProject |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Deletes a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
- Create a new 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 project topology tree
- Get the object tree with full property list without geometry
- 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/<company>/objects Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new object |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the object tree with full property list whose geometry type is "mesh"(default)
...
id | bimGetObject2 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id> URL: https://api.bimplus.net/v2/<company>/objects/<object_id> Example: https://api.bimplus.net/v2/bimplus/projects |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the full property list of the object without geometry
...
id | bimGetObject4 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/nogeometry URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/nogeometry Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get the full property list of the object without geometry |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the project topology tree
...
id | bimGetObject5 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/projecttree URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/projecttree Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get the project topology tree. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the object tree with full property list without geometry
...
id | bimGetObject6 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/topology URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/topology Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get the object tree with full property list without geometry. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
...
id | bimGetObject7 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/geometries/threejs URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/geometries/threejs Example: https://api.bimplus.net/v2/bimplus/projects |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
...
id | bimGetObject8 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/geometries/meshblob URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/geometries/meshblob Example: https://api.bimplus.net/v2/bimplus/projects |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline*
...
id | bimGetObject9 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs Example: https://api.bimplus.net/v2/bimplus/projects |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline*
...
id | bimGetObject10 |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob URL: https://api.bimplus.net/v2/<company>/projects Example: https://api.bimplus.net/v2/bimplus/projects |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update the object*
...
id | bimObjectUpdate |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Resource: objects/<object_id> URL: https://api.bimplus.net/v2/<company>/objects/<object_id> Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing object with a new one. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Create a new attachment in the object
...
id | bimObjCreateAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: objects/<object_id>attachments URL: https://api.bimplus.net/v2/<company>/objects/<object_id>attachments Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new attachment in a object. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the attachment list from the object
...
id | bimGetObjAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>attachments URL: https://api.bimplus.net/v2/<company>/objects/<object_id>attachments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get all the attachments belonging to a specified object. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete all the attachments from the project
...
id | bimDeleteObjAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id>/attachments URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Delete all the attachments from a specified project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the object
...
id | bimObjDelete |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: objects/<object_id> URL: https://api.bimplus.net/v2/<company>/objects/<object_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Deletes a specified object. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
- Get all the 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/<company>/attachments/<attachment_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get detailed information about a specified attachment. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Download the attachment
...
id | bimDownloadAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: attachments/<attachment_id>/download URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>/download Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Download the content of a specified attachment. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update the attachment
...
id | bimUpdateAttachment |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: attachments/<attachment_id> URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id> Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing attachment with a new one. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the Attachment
...
id | bimDeleteAttachment |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: attachments/<attachment_id> URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Deletes a specified attachment. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
Issue Service
...
- Get details of the issue
- Get all the issue types
- Get details of the issue type
- Create a new pin for the issue
- Get all the pins of the issue
- Delete all the pins from the issue
- Create a new comment for the issue
- Get all the comments of the issue
- Delete the comment
- Create a new attachment for the issue
- Get the attachment list from the issue
- Delete all the attachments from the issue
- Update the issue
- Delete the issue
...
Get details of the issue
...
id | bimGetIssueDetails |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id> URL: https://api.bimplus.net/v2/<company>/issues/<issue_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get details of an issue present in a project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get all the issue types
...
id | bimGetIssueTypest |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/types URL: https://api.bimplus.net/v2/<company>/issues/types Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get all the available issue types. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get details of the issue type
...
id | bimGetIssueTypeDetails |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/types/<type_id> URL: https://api.bimplus.net/v2/<company>/issues/types/<type_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get details of a specified issue type. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Create a new pin for the issue
...
id | bimCreatePin |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Resource: issues/<issue_id>/pins URL: https://api.bimplus.net/v2/<company>/projects Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new pin for an issue for relating the issue with its object. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get all the pins of the issue
...
id | bimGetAllPins |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/pins URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get all the pins of a specified issue type. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete all the pins from the issue
...
id | bimDeleteAllPins |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/pins URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Delete all the pins from a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Create a new comment for the issue
...
id | bimCreateComment |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/comments URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Create a new comment for a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get all the comments of the issue
...
id | bimGetAllComments |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/comments URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get all the comments of a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the comment
...
id | bimDeleteComment |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/comments/<comment_id> URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments/<comment_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Deletes a specified comment. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Create a new attachment for the issue
...
id | bimCreateAttachmentForIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Resource: issues/<issue_id>/attachments URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Creates a new attachment for a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the attachment list from the issue
...
id | bimGetAttachmentListFromIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/attachments URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Gets the attachment list from a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete all the attachments from the issue
...
id | bimDeleteAttachmentFromIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id>/attachments URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Delete all the attachments from a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update the issue
...
id | bimUpdateIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
Resource: issues/<issue_id> URL: https://api.bimplus.net/v2/<company>/issues/<issue_id> Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Update or replace a specified existing issue with a new one. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the issue
...
id | bimDeleteIssue |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: issues/<issue_id> URL: https://api.bimplus.net/v2/<company>/issues/<issue_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Deletes a specified issue. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
Pin Service
...
- Get details of the pin
- Update the pin
- Delete the pin
...
Get details of the pin
...
id | bimGetPinDetails |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: pins/<pin_id> URL: https://api.bimplus.net/v2/<company>/pins/<pin_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get details of a specified pin. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update the pin
...
id | bimPinUpdate |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||
---|---|---|---|---|
| ||||
Resource: pins/<pin_id> URL: https://api.bimplus.net/v2/<company>/pins/<pin_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Update or replace a specified existing pin with a new one. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the pin
...
id | bimGetPinDetails |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
DELETE |
Card | ||||
---|---|---|---|---|
| ||||
Resource: pins/<pin_id> URL: https://api.bimplus.net/v2/<company>/pins/<pin_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Deletes a specified pin. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
Import Service
...
- Create a new project by importing SketchUp and IFC files.
- Create a new sub-project by importing SketchUp and IFC files.
...
Create a new project by importing SketchUp and IFC files
...
id | bimCreateProjectFromIFC |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: import URL: https://api.bimplus.net/v2/<company>/import Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Create a new project by importing SketchUp and IFC files into the team database. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Create a new sub-project by importing SketchUp and IFC files
...
id | bimCreateSubProjectFromIFC |
---|
Card | ||
---|---|---|
| ||
Service not finished yet ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: projects/<project_id>/import URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/import Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Create a new sub-project by importing SketchUp and IFC files into the project. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
Authorization Service
...
- Authenticate by requesting and receiving a token
- Get token information
- Revoke / Terminate the token
...
Authenticate by requesting and receiving a token
...
id | bimAuthenticateToken |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
POST |
Card | ||||
---|---|---|---|---|
| ||||
Resource: authorize URL: https://api.bimplus.net/v2/<company>/authorize Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Authenticate by requesting and receiving a token. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get token information
...
id | bimGetTokenInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: tokeninfo?access_token=<token> URL: https://api.bimplus.net/v2/<company>/tokeninfo?access_token=<token> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get information about a specified token. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Revoke / Expire the token
...
id | bimExpireToken |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: revoke?token=<token> URL: https://api.bimplus.net/v2/<company>/revoke?token=<token> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
The specified token will expire immediately. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
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/<company>/users Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Creates a new user account. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get information about the user
...
id | bimGetUserInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: users/<user_id> URL: https://api.bimplus.net/v2/<company>/users/<user_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get information about a specified user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update information about the user
...
id | bimUpdateUserInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||
---|---|---|---|---|
| ||||
Resource: users/<user_id> URL: https://api.bimplus.net/v2/<company>/users/<user_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Update information about a specified user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get information about the currently logged in user
...
id | bimGetCurrentUserInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: user URL: https://api.bimplus.net/v2/<company>/user Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get information about the currently logged in user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
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/<company>/teams Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Create a new team and its related database. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get information about the team
...
id | bimGetTeamInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: teams/<team_id> URL: https://api.bimplus.net/v2/<company>/teams/<team_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get information about a specified team. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update information about the team
...
id | bimUpdateTeamInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
Resource: teams/<team_id> URL: https://api.bimplus.net/v2/<company>/teams/<team_id> Example: https://api.bimplus.net/v2/bimplus/projects JSON Structure:
|
Card | ||
---|---|---|
| ||
Update information about a specified team. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the team list in which the current logged in user is a member of
...
id | bimGetTeamFromCurrentUser |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: teams URL: https://api.bimplus.net/v2/<company>/teams Example: https://api.bimplus.net/v2/bimplus/projects |
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
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/<company>/<team_id>/members Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Add a specified user to a specified team. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Get the member list of the team
...
id | bimGetMemberListInfo |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
GET |
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_id>/members URL: https://api.bimplus.net/v2/<company>/<team_id>/members Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Get information about a specified user. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Update information about the user in the team
...
id | bimUpdateUserInfoInTeam |
---|
Card | ||
---|---|---|
| ||
Service available ! |
Card | ||
---|---|---|
| ||
PUT |
Card | ||||
---|---|---|---|---|
| ||||
Resource: <team_id>/members/<user_id> URL: https://api.bimplus.net/v2/<company>/<team_id>/members/<user_id> Example: https://api.bimplus.net/v2/bimplus/projects |
Card | ||
---|---|---|
| ||
Update information about a specified user in a team. |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
} |
...
Delete the user from the team
...
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|