Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 56

...

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)

Composition Setup

Deck of Cards
idbimRequestTokenbimGetProjectList
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POST

Card
labelURL / Resource / Parameters

Resource: authorize 

URLhttps://api.bimplus.net/v2/authorize

Card
defaulttrue
labelDescription

Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.

true
Card
default
labelRequest
Code Block
borderColorGreen
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
Status: 200 OK


Code Block
borderColorRed
titleJSON
{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
}

...

The token is received in the request

...

idbimReceiveToken
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

POST

Card
labelURL / Resource / Parameters

Resource: authorize 

URLhttps://api.bimplus.net/v2/authorize

Card
labelDescription

Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.

...

JSON
Request
Code Block
borderColorGreen
titleHeaders

Content-Type: application/json
Code Block
borderColorRed
title
{
"user_id" : "test@bimplus.net", "password" : "test" }
Card
defaulttrue
labelResponse
Code Block
borderColorGreen
titleStatus

Status: 200 OK
Code Block
borderColorRed
titleJSON
{
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

...

idbimGetProjectList
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

GET

...

labelURL / Resource / Parameters

Resource: projects 

...

GET https://api.bimplus.net/v2/

...

bimplus/projects

JSON Response:

Code Block
[4
Card
defaulttrue
labelDescription

Get available project list with main properties.

Card
labelRequest
Code Block
borderColorGreen
titleHeaders

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus

Status: 200 OK
Code Block
borderColorRed
titleJSON
[3
]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: 
"!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
null
}-
1:  {
id: "
2d703abe
f404ee03-
b4f9
2e04-
407c
4d81-
af53
873e-
a39c5b7ba872
13d672b02b7d"
name: 
"__5 999 Parklife Salzburg Lehen"
null
}-
2:  {
id: "
c480cc54
1dc48a10-
aec4
f283-
4bef
497a-
8d35
83de-
93bb090e1aba
e5f1b56c4a41"
name: 
"0811-Wohnhaus Kraus - Carport1" }

Get Project Properties

Deck of Cards
idbimGetProjectProp
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

GET

Card
labelURL / Resource / Parameters

Resource: projects/<project_id>

URLhttps://api.bimplus.net/v2/<company>/projects/<project_id>

Examplehttps://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card
defaulttrue
labelDescription

Get all the project properties of a project using its id.

Card
labelRequest
Code Block
borderColorGreen
titleHeaders

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus

Status: 200 OK
Code Block
borderColorRed
titleJSON
{ 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-0049f1f9d4ff
null
}-
3:  {
id: "586b02be-43b8-4e27-b698-e067e85e38e2"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}

Tools 

Anchor
Test
Test

Plugins for doing REST based calls (REST Client)

...