...
If the Browser based REST clients does not select the Content-Type as "application/json", then please mention the content type in the header(Content-Type: application/json)
Deck of Cards |
---|
id | bimRequestTokenbimGetProjectList |
---|
|
Card |
---|
label | Implementation Status |
---|
| Service available ! |
Card |
---|
label | URL / Resource / Parameters |
---|
| Resource: authorize URL: https://api.bimplus.net/v2/authorize |
Card |
---|
default | true |
---|
label | Description |
---|
| Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources. |
Card |
---|
default | true |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
|
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
| {
"user_id" : "test@bimplus.net",
"password" : "test"
} |
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
|
Status: 200 OK
|
Code Block |
---|
| {
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
} |
|
|
...
The token is received in the request
...
Card |
---|
label | Implementation Status |
---|
|
Image Removed Service available ! |
Card |
---|
label | URL / Resource / Parameters |
---|
|
Resource: authorize URL: https://api.bimplus.net/v2/authorize |
Card |
---|
|
Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources. |
...
Request | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
|
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
{
"user_id" : "test@bimplus.net",
"password" : "test"
} Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
|
Status: 200 OK
|
Code Block |
---|
|
{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
} |
Code Block |
---|
{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
} |
...
Using the authentication token, the necessary resource can be accessed and the desired action can be performed on that resource using the BimPlus REST API.
Example:
Get Project List
...
Card |
---|
label | Implementation Status |
---|
|
Image Removed Service available ! |
...
label | URL / Resource / Parameters |
---|
Resource: projects
...
GET https://api.bimplus.net/v2/
...
bimplus/projects
JSON Response:
Code Block |
---|
[4 Card |
---|
default | true |
---|
label | Description |
---|
| Get available project list with main properties. |
Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
|
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
|
Status: 200 OK
|
Code Block |
---|
|
[3]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name:
"!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"null
}-
1: {
id: "
2d703abef404ee03-
b4f92e04-
407c4d81-
af53873e-
a39c5b7ba87213d672b02b7d"
name:
"__5 999 Parklife Salzburg Lehen"null
}-
2: {
id: "
c480cc541dc48a10-
aec4f283-
4bef497a-
8d3583de-
93bb090e1abae5f1b56c4a41"
name:
"0811-Wohnhaus Kraus - Carport1"
}
Get Project Properties
Deck of Cards |
---|
|
Card |
---|
label | Implementation Status |
---|
| Image Removed Service available ! |
Card |
---|
label | URL / Resource / Parameters |
---|
| Resource: projects/<project_id> URL: https://api.bimplus.net/v2/<company>/projects/<project_id> Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff
|
Card |
---|
default | true |
---|
label | Description |
---|
| Get all the project properties of a project using its id. |
Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
|
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
|
Status: 200 OK
|
Code Block |
---|
|
{
disciplines: [0]
name: null
shortDescr: null
thumbnail: null
created: "0001-01-01T00:00:00"
changed: "0001-01-01T00:00:00"
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ffnull
}-
3: {
id: "586b02be-43b8-4e27-b698-e067e85e38e2"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}
Tools
Plugins for doing REST based calls (REST Client)
...