Versions Compared

Old Version 334

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 335

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimUpdateProject
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 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: 

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the project

shortDescr

optional

string

Short description of the project

created

will be ignored

string (date)

Creation date of the project

changed

will be ignored

string (date)

Changed date of the project

Card
labelDescription
 Update or replace a specified existing project with a new one.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Deck of Cards
 

 

  • See the updated project properties

 

Deck of Cards
Card
labelHTTP Method
 GET

 

...

 

Card

 

Card
defaulttrue
labelURL / Resource / JSON Structure
 
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

 

 

 

 

 

Card
labelDescription
 

...

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

 

 

 

 

 

 

 

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

 
 
 
 
 
 
 
 
 
 Card
labelResponse
 
 Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 
 
 
 Code Block
borderColorRed
titleJSON
langxml
{
    "name": "Your Awesome Building",
    "shortDescr": "The example project",
    "thumbnail": "/nemetschek/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail/download",
    "created": "0001-01-01T00:00:00",
    "changed": "0001-01-01T00:00:00",
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "properties": {
        "mainfloorarea": "456m²",
        "architect": {
            "name": "NemetschekTech.GmbH",
            "street": "Konrad-Zuse-Platz1",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "zip": "81829",
            "city": "Munich"
        },
        "customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "zip": "08201",
            "city": "New Jersy"
        }
    },
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

 
 
 
 
 
 
 
 
 
 
 
 
 
 Anchor
 storyTopologyTree
 storyTopologyTree
...
 
 Deck of Cards
idbimAuthenticateToken
 Card
labelHTTP Method
 
 POST
POST
 Card
 Card
 
labelURL / Resource / JSON Structure
 
Resource: authorize 
URL: https://api.bimplus.net/v2/authorize
JSON Structure: 
Name
Mandatory / Optional
Type
Description
user_id
mandatory
string
The email address of the user
password
mandatory
string
The user's password
client_id
optional
string
The identifier of the used client
application_id
optional
string
The id of the application
...
 Card
 
 Card
labelDescription
 
...
 Authenticate by requesting and receiving a token.
...
cardcarddeck
 Card
 
 Card
labelRequest
 
 Code Block
borderColorGreen
titleHeaders
langxml
Content-Type: application/json

 Code Block
borderColorRed
titleJSON
langxml
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

 
 
 Card
defaulttrue
labelResponse
 
 Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 Code Block
borderColorRed
titleJSON
langxml
{
access_token: "e3271e89d8ea474c82745039bc2bed0d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

 
 
 
 
 
 
 
 
Use the client_id "9fd0bb9d-570b-4719-bfae-93e2f879c19a" to generate a token for multiple logins.
 
 Deck of Cards
idbimAuthenticateToken
 Card
labelHTTP Method
 
 POST
POST
 Card
 Card
 
labelURL / Resource / JSON Structure
 
Resource: authorize 
URL: https://api.bimplus.net/v2/authorize
JSON Structure: 
Name
Mandatory / Optional
Type
Description
user_id
mandatory
string
The email address of the user
password
mandatory
string
The user's password
client_id
optional
string
The identifier of the used client
application_id
optional
string
The id of the application
...
 Card
 
 Card
labelDescription
 
...
 Authenticate by requesting and receiving a token.
 
 Card
 
 Card
defaulttrue
labelRequest
 Code Block
borderColorGreen
titleHeaders
langxml
Content-Type: application/json

 Code Block
borderColorRed
titleJSON
langxml
{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "client_id" : "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
}

 Card
 
 Card
labelResponse
 
 Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 Code Block
borderColorRed
titleJSON
langxml
{
access_token: "c33fa174169e46999fe82fb07fc53e3d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

 Card
 
 Deck of Cards
 
 
  • For switching the client, the cross token service can be used. This service is basically used for requesting a disposable temporary token which will be used for authenticating against different clients. Based on the given authentication token the user is identified and a one time token is generated and returned. This one time cross token is valid only for 5 minutes and is used for logging into the given device/client using cross authentication service . As a result of this call, this one time cross token will be removed but the new token which will be generated can be used in the header for the subsequent API calls.
...