Page History

...

Deck of Cards

id	bimGetUserInfo

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api-stage.bimplus.net/v2/users/<user_id>

Example: https://api-stage.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified user.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

...

PUT

Deck of Cards

id	bimUpdateUserInfo

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api-stage.bimplus.net/v2/users/<user_id>

Example: https://api-stage.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure:

Name	Mandatory / Optional	Type	Description
email	mandatory	string	Email of the user
status	mandatory	string	The status of the account (Active / Inactive)
password	mandatory	string	Password of the user
firstname	optional	string	First name of the user
lastname	optional	string	Last name of the user
company	optional	string	Company of the user
displayname	optional	string	Display name of the user
info	optional	string	Information of the user
gender	optional	string	Gender of the user
phoneWork	optional	string	Office phone number of the user
phoneHome	optional	string	Home phone number of the user
fax	optional	string	Fax number of the user
mobile	optional	string	Mobile number of the user
birthDate	optional	string	Birth date of the user
address	optional	object	Address of the user
street	optional	string	Street name of the user
streetNr	optional	string	Street number of the user
zip	optional	string	Zip code
city	optional	string	City name of the user
country	optional	string	Country name of the user
preferredLanguage	optional	string	Preferred language of the user (will be set in the portal)
teams	will be ignored	array	Team list of the user
team	will be ignored	object	Information about an user's team (See the team service)
projects	will be ignored	array	Project list of the user
project	will be ignored	object	Information about an user's project (See the project service)

Card

label	HTTP Method

PUT

Card

label	Description

Update information about a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

DELETE

Deck of Cards

id	bimDeleteUser

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: users

URL: https://api-stage.bimplus.net/v2/users/<user_id>

Example: https://api-stage.bimplus.net/v2/users/08b8195a-a2ad-11e2-9993-002215ea7d6b

Card

label	HTTP Method

DELETE

Card

label	Description

Delete a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

GET

Deck of Cards

id	bimGetCurrentUserInfo

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

URL: https://api-stage.bimplus.net/v2/user

Card

label	HTTP Method

GET

Card

label	Description

Get information about the currently logged in user.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

...

POST

Deck of Cards

id	bimCreateNewTeam

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

URL: https://api-stage.bimplus.net/v2/teams

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	mandatory	string	The unique name which will be used in the url
name	mandatory	string	Name of the team
displayname	mandatory	string	The name of the team which will be displayed in the client
owner	mandatory	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	mandatory	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	will be ignored	integer	The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
status	will be ignored	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline
haswriteaccess	will be ignored	boolean	Write access to the team
public	optional	object	Public read/write rights
read	optional	boolean	Read right (viewer right to all the projects under this team to all the registered users)
write	optional	boolean	Write right (write right to all the projects under this team to all the registered users)
rights	object	object	Project rights
projectCreate	will be ignored	boolean	The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it)

Card

label	HTTP Method

POST

Card

label	Description

Create a new team and its related database. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection":     "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false,
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

...

HTTP Method

Deck of Cards

id	bimGetTeamInfo

Card

label

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_slug>

URL: https://api-stage.bimplus.net/v2/teams/<team_slug>

Example: https://api-stage.bimplus.net/v2/teams/best-company

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified team.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "displayname": "Best Company (best-company)",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection":   "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

...

PUT

Deck of Cards

id	bimUpdateTeamInfo

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_slug>

URL: https://api-stage.bimplus.net/v2/teams/<team_slug>

Example: https://api-stage.bimplus.net/v2/teams/best-company

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	will be ignored	string	The unique name which will be used in the url
name	mandatory	string	Name of the team
owner	will be ignored	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	mandatory	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	will be ignored	integer	The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
status	mandatory	string	Active / Inactive
teamWorksConnection	will be ignored	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	will be ignored	string	Online / Offline
haswriteaccess	will be ignored	boolean	Write access to the team
public	optional	object	Public read/write rights
read	optional	boolean	Read right (viewer right to all the projects under this team to all the registered users)
write	optional	boolean	Write right (write right to all the projects under this team to all the registered users)
rights	object	object	Project rights
projectCreate	will be ignored	boolean	The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it)

Card

label	HTTP Method

PUT

Card

label	Description

Update information about a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
        "name": "Best Company",
        "totalStorage": 500000000,
        "status": "Active"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

DELETE

Deck of Cards

id	bimDeleteTeam

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_slug>

URL: https://api-stage.bimplus.net/v2/teams/<team_id>

Example: https://api-stage.bimplus.net/v2/teams/08b8195a-a2ad-11e2-9993-002215ea7d6b

Card

label	HTTP Method

DELETE

Card

label	Description

Delete a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

HTTP Method

Deck of Cards

id	bimGetTeamFromCurrentUser

Card

label

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

URL: https://api-stage.bimplus.net/v2/teams

Card

label	HTTP Method

GET

Card

label	Description

Get a team list in which the current logged in user is a member of

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
        "slug": "best-company",
        "name": "Best Company",
        "displayname": "Best Company (best-company)",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": true,
        "rights": {
            "projectCreate": true
        }
    },
    {
        "id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
        "slug": "nemetschek",
        "name": "Nemetschek",
        "displayname": "Nemetschek (nemetschek)",
        "owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "totalStorage": 0,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    },
    {
        "id": "7eab1453-a4e7-4d05-983e-031544540e6f",
        "slug": "bimplus-demo",
        "name": "BimPlusDemo",
        "displayname": "BimPlusDemo (bimplus-demo)",
        "owner": "5592c628-588e-f5c0-b08b-088d43de9209",
        "totalStorage": 53687091200,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    }
]

...

POST

Deck of Cards

id	bimAddUserToTeam

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/members

Example: https://api-stage.bimplus.net/v2/best-company/members

JSON Structure:

Name	Mandatory / Optional	Type	Description
user	mandatory	object	Information of the user
user.id	mandatory	string	Id of the user
user.email	will be ignored	string	Email of the user
user.status	will be ignored	string	Status of the user(Active / Inactive)
roles	will be ignored	object	Roles of the user
member_status	optional	string	Status of the membership(Active / Passive)

Card

label	HTTP Method

POST

Card

label	Description

Add a specified user to a specified team.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
    },
    "roles": [
        "Member"
    ],
    "member_status": "Active"

}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 Ok

...

GET

Deck of Cards

id	bimGetMemberListInfo

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/members

Example: https://api-stage.bimplus.net/v2/best-company/members

Card

label	HTTP Method

GET

Card

label	Description

Gets the member list of a specified team.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
            "email": "test@bimplus.net",
            "status": "Active"
        },
        "roles": [
            "Member"
        ],
        "status": "Active"
    },
    {
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7",
            "email": "customer@bimplus.net",
            "status": "Active"
        },
        "roles": [
            "Member"
        ],
        "status": "Passive"
    }
]

...

PUT

Deck of Cards

id	bimUpdateUserInfoInTeam

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members/<user_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/members/<user_id>

Example: https://api-stage.bimplus.net/v2/best-company>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure:

Name	Mandatory / Optional	Type	Description
user	mandatory	object	Information of the user
user.id	mandatory	string	Id of the user
status	mandatory	string	Status of the membership(Active / Passive)

Card

label	HTTP Method

PUT

Card

label	Description

Update information about a specified user in a team.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
        },
        "status": "Active"
    }

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

HTTP Method

Deck of Cards

id	bimDeleteUserFromTeam

Card

label

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/members/<user_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/members/<user_id>

Example: https://api-stage.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified user from a team.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

GET

Deck of Cards

id	bimGetAllRoles

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles

URL: https://api-stage.bimplus.net/v2/<team_slug>/roles

Example: https://api-stage.bimplus.net/v2/best-company/roles

Card

label	HTTP Method

GET

Card

label	Description

Get all the available. Right now, we support only project based roles.

Here is the definition of Bimplus Rights & Roles.

	Account Owner	Project Admin	Project Editor	Project Viewer	Model Admin	Model Editor	Model Viewer
Create Project	x	x
Admin Project (eg. invite)	x	x
Edit Project	x	x	x
Delete Project	x	x
View Project	x	x	x	x	x	x	x

View all Models	x	x	x	x
Create Model	x	x	x
Admin Model (eg. invite)	x	x
Assign User to Model	x	x	x		x
Edit Model	x	x	x		x	x
Import Data	x	x	x		x	x
Delete Model	x	x	x		x
View Model	x	x	x	x	x	x	x

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 Ok

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
        "name": "Project_Editor",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Edit",
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    },
    {
        "id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
        "name": "Account_Owner",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightGlobal",
                "rights": [
                    "AllProjects",
                    "AllModels",
                    "Project_Create"
                ]
            }
        ]
    },
    {
        "id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
        "name": "Project_Admin",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Admin",
                    "Project_Edit",
                    "Project_Delete",
                    "Project_View",
                    "Model_ViewAll",
                    "Model_Create"
                ]
            }
        ]
    },
    {
        "id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
        "name": "Project_Viewer",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    }
]

...

HTTP Method

Deck of Cards

id	bimassignProjectRole

Card

label

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members

Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

JSON Structure:

Name	Mandatory / Optional	Type	Description
member	mandatory	object	The member who will be assigned a role to the project
id	mandatory	string (guid)	Id of the user
role	mandatory	object	The project role which will be assigned to the team member
id	mandatory	string (guid)	Id of the role

Card

label	HTTP Method

POST

Card

label	Description

Assign a project role to an existing member of a team. Only the user with "Account Owner" or "Project Owner" role can use this API call.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25"
  },
  role: {
    id: "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Editor"
}

...

HTTP Method

Deck of Cards

id	bimGetMembersWithRoles

Card

label

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members

Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

Card

label	HTTP Method

GET

Card

label	Description

Get the member list of a project along with their respective project roles.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "member": {
            "id": "7aa846f2-6014-f68d-8dd4-4c7941d7cbcc",
            "email": "customer1@bimplus.net"
        },
        "role": {
            "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Editor"
        }
    },
    {
        "member": {
            "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
            "email": "customer2@bimplus.net"
        },
        "role": {
            "id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Viewer"
        }
    }
]

...

PUT

Deck of Cards

id	bimUpdateProject

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members

Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

JSON Structure:

Name	Mandatory / Optional	Type	Description
member	mandatory	object	The member who will be assigned a role to the project
id	mandatory	string (guid)	Id of the user
role	mandatory	object	The project role which will be assigned to the team member
id	mandatory	string (guid)	Id of the role

Card

label	HTTP Method

PUT

Card

label	Description

Update the project role of a team member. Only the user with "Account Owner" or "Project Owner" role can use this API call.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Viewer"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

DELETE

Deck of Cards

id	bimdeleteProjectRole

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/members

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/members

Example: https://api-stage.bimplus.net/v2/bimplus/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

Card

label	HTTP Method

DELETE

Card

label	Description

Remove the user from a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

HTTP Method

Deck of Cards

id	bimActivateUser

Card

label

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/users/<userId>

URL: https://api-stage.bimplus.net/v2/administration/users/<userId>

Example: https://api-stage.bimplus.net/v2/administration/users/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure:

Name	Mandatory / Optional	Type	Description
activeStatus (active_status can be "active" or "disabled")	mandatory	string ("active" or "disabled")	Whether to activate or deactivate the user
adminId	mandatory	string	The id of the shop admin who has activated/deactivated the user
reason	mandatory	string	Reason for activating/deactivating the user

Card

label	HTTP Method

PUT

Card

label	Description

Activate or deactivate the specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "activeStatus": "Disabled",
    "adminId": "ade041e7312da9e4aghc64403fbcd21517ttt",
    "reason": "Testing the deactivate functionality"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Green
title	Response
lang	xml

{
    "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
    "email": "test@bimplus.net",
    "status": "Disabled",
    "adminLog": [
        {
            "id": "43d3187e-87a5-4e11-9f68-a2c90097e2ba",
            "action": "Disabled",
            "author": "ade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:12:59.9252404Z"
        },
        {
            "id": "0f2d654a-3630-4ec9-9039-a2c900977117",
            "action": "Active",
            "author": "ade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:11:22.9546122"
        },
        {
            "id": "e6081130-7ab5-45a7-a168-a2c8012a560a",
            "action": "Disabled",
            "author": "ade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-04T17:06:12.5076209"
        }
    ]
}

...

PUT

Deck of Cards

id	bimActivateTeam

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/users/<teamId>

URL: https://api-stage.bimplus.net/v2/administration/teams/<teamId>

Example: https://api-stage.bimplus.net/v2/administration/teams/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure:

Name	Mandatory / Optional	Type	Description
activeStatus (active_status can be "active" or "disabled")	mandatory	string ("active" or "disabled")	Whether to activate or deactivate the team
adminId	mandatory	string	The id of the shop admin who has activated/deactivated the team
reason	mandatory	string	Reason for activating/deactivating the team

Card

label	HTTP Method

PUT

Card

label	Description

Activate or deactivate the specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "activeStatus": "disabled",
    "adminId": "ase041e7312da9ert4ac64403fbcdde21517h",
    "reason": "Testing the deactivate functionality"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Green
title	Response
lang	xml

{
 "publicRead": false,
 "publicWrite": false,
 "teamDbName": "BimPlus.Tenant.Dev.jay-company",
 "payment": null,
 "lastLogin": "0001-01-01T00:00:00",
 "failedLogins": 0,
 "owner": {
 "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
 "email": "jayaraj.purushothaman@gmail.com",
 "firstname": "Jayaraj",
 "lastname": "Purushothaman",
 "company": "Jay Company",
 "fullname": "Jayaraj Purushothaman",
 "displayname": "Jayaraj Purushothaman [Jay Company]",
 "info": "",
 "gender": "MR",
 "phoneWork": "",
 "phoneHome": "",
 "fax": "",
 "mobile": "",
 "birthDate": "0000-00-00",
 "address": {
 "street": "Konrad Zuse platz",
 "streetNr": "1",
 "zip": "81829",
 "city": "Munich",
 "country": "Germany"
 },
 "preferedLanguage": "de",
 "wrongLogins": 0
 },
 "invitees": 2,
 "teamMembers": [
 {
 "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
 "firstname": "Unknown",
 "lastName": "User",
 "fullName": "Unknown User",
 "email": "jayaraj.purushothaman@bimplus.net",
 "roleName": null,
 "invitationStatus": null
 },
 {
 "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
 "firstname": "Unknown",
 "lastName": "User",
 "fullName": "Unknown User",
 "email": "ssudha84@gmail.com",
 "roleName": null,
 "invitationStatus": null
 }
 ],
 "adminLog": [
 {
 "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
 "action": "Disabled",
 "author": "ase041e7312da9ert4ac64403fbcdde21517h",
 "reason": "Testing the deactivate functionality",
 "timestamp": "2014-02-07T08:43:14.7675944Z"
 },
 {
 "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
 "action": "Active",
 "author": "ase041e7312da9ert4ac64403fbcdde21517h",
 "reason": "Testing the deactivate functionality",
 "timestamp": "2014-02-07T08:43:01.0644085"
 }
 ],
 "id": "c3018713-a313-4bab-a952-2fddb58fb171",
 "slug": "jay-company",
 "name": "Jay Company",
 "server": "k2146.ims-firmen.de",
 "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
 "status": "Disabled",
 "countMembers": 3,
 "countProjects": 1,
 "usedSpace": 106
}

...

GET

Deck of Cards

id	bimGetUsersActivationStatus

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/users

URL: https://api-stage.bimplus.net/v2/administration/users

Example: https://api-stage.bimplus.net/v2/administration/users

Card

label	HTTP Method

GET

Card

label	Description

Get the list of all the users with the activation status. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

 [
    {
        "id": "6790ad40-99e1-cef2-cabd-1bd05bbb3335",
        "email": "user1@bimplus.net",
        "status": "Active"
    },
    {
        "id": "43d2d1c8-f0eb-9804-d2a2-1f36c8fb7a45",
        "email": "user2@bimplus.net",
        "status": "Disabled"
    },
    {
        "id": "39b31bb4-b413-3dc9-6036-214392facb49",
        "email": "user3@bimplus.net",
        "status": "Active"
    },
    {
        "id": "91188cc9-6202-a9e9-8ada-23fbca9c7b34",
        "email": "user4@bimplus.net",
        "status": "Active"
    }
]

...

GET

Deck of Cards

id	bimGetTeamsActivationStatus

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/teams

URL: https://api-stage.bimplus.net/v2/administration/teams

Example: https://api-stage.bimplus.net/v2/administration/teams

There is a paging and sorting possibility available for this API call. Please see the request section.

Card

label	HTTP Method

GET

Card

label	Description

Get the list of all the teams with the activation status. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

There is a paging and sorting possibility available for this API call. Please see the request section.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
 
For the paging & sorting possibility, send the following properties in the header:
pageSize (mandatory for paging): Number of hits which will be displayed on one page
pageIndex (mandatory for paging): The page number which has to be loaded
sortColumn (optional): The name of the column which will be sorted (possible only with some limitations)
sortDirection (optional)("asc" or "desc"): Sort direction (asc is default)

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "c9e80035a-de61-4d84-b324-0308cc073a0c",
        "slug": "testteam",
        "name": "testteam",
        "server": "k2145.ims-firmen.de",
        "ownerId": "fc5d0b370-6005-484c-8f47-b9e52e8ac6eaf",
        "status": "Active",
        "countMembers": 1,
        "countProjects": 608,
        "usedSpace": 1973
    },
    {
        "id": "a1e500195-b9cc-495c-bb3a-ab01ada0ca01a",
        "slug": "bimplus-gmbh",
        "name": "Bimplus GmbH",
        "server": "k2145.ims-firmen.de",
        "ownerId": "g6e67ba07-50c3-d51d-23f0-3ac0d8788202g",
        "status": "Active",
        "countMembers": 1,
        "countProjects": 3,
        "usedSpace": 237
    }
]

...

GET

Deck of Cards

id	bimGetUserActivationStatus

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/users/<user_id>

URL: https://api-stage.bimplus.net/v2/administration/users/<user_id>

Example: https://api-stage.bimplus.net/v2/administration/users/<user_id>

Card

label	HTTP Method

GET

Card

label	Description

Get the activation status and the status log of the specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
    "email": "user1@bimplus.net",
    "status": "Active",
    "adminLog": [
        {
            "id": "3ccecf46-69fa-4a5f-bca3-a2cb0098fcac",
            "action": "Active",
            "author": "ae041e7312da9e4ac64403fbcdde21517b",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:17:00.5172929"
        },
        {
            "id": "43d3187e-87a5-4e11-9f68-a2c90097e2ba",
            "action": "Disabled",
            "author": "ce041e7312da9e4ac64403fbcdde21517d",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:12:59.9252404"
        },
        {
            "id": "0f2d654a-3630-4ec9-9039-a2c900977117",
            "action": "Active",
            "author": "ae041e7312da9e4ac64403fbcdde21517b",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:11:22.9546122"
        },
        {
            "id": "e6081130-7ab5-45a7-a168-a2c8012a560a",
            "action": "Disabled",
            "author": "ae041e7312dagg9e4ac64403fbcdde21517u",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-04T17:06:12.5076209"
        }
    ]
}

...

Get the activation status and the status log for a team

GET

Deck of Cards

id	bimGetTeamActivationStatus

Deck of Cards

id	bimGetTeamActivationStatus

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/teams/<team_id>

URL: https://api-stage.bimplus.net/v2/administration/teams/<team_id>

Example: https://api-stage.bimplus.net/v2/administration/teams/<team_id>

Card

label	HTTP Method

GET

Card

label	Description

Get the activation status and the status log of the specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "publicRead": false,
    "publicWrite": false,
    "teamDbName": "BimPlus.Tenant.Dev.jay-company",
    "payment": null,
    "lastLogin": "0001-01-01T00:00:00",
    "failedLogins": 0,
    "owner": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en",
        "wrongLogins": 0
    },
    "invitees": 2,
    "teamMembers": [
        {
            "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "jayaraj.purushothaman@bimplus.net",
            "roleName": null,
            "invitationStatus": null
        },
        {
            "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "ssudha84@gmail.com",
            "roleName": null,
            "invitationStatus": null
        }
    ],
    "adminLog": [
        {
            "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
            "action": "Disabled",
            "author": "afe041e7312da9e4ac64403fbcdde215",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:14.7675944"
        },
        {
            "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
            "action": "Active",
            "author": "afe041e7312da9e4ac64403fbcdde215",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:01.0644085"
        }
    ],
    "id": "c3018713-a313-4bab-a952-2fddb58fb171",
    "slug": "jay-company",
    "name": "Jay Company",
    "server": "k2146.ims-firmen.de",
    "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "status": "Disabled",
    "countMembers": 3,
    "countProjects": 1,
    "usedSpace": 106
}

...

GET

Deck of Cards

id	bimGetAllDBServers

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/dbserverstatistics

URL: https://api-stage.bimplus.net/v2/administration/dbserverstatistics

Example: https://api-stage.bimplus.net/v2/administration/dbserverstatistics

Card

label	HTTP Method

GET

Card

label	Description

Retrieves the details of all the DB servers found in the Bimplus platform. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

 [
    {
        "id": "6c3bcbd4-df39-4b5c-9d55-257d15b6f2f2",
        "dbServerName": "k3345.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,
        "dbSpaceUsed": 24603,
        "growingSumLastWeekSpaceUsed": 2717,
        "growingSumLastMonthSpaceUsed": 14853,
        "growingPerDayLastWeekSpaceUsed": 388.14285714285717,
        "growingPerDayLastMonthSpaceUsed": 479.1290322580645,
        "growingDaysLastMonth": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 775397,
        "dbSpaceRemainingPercentage": 96.9,
        "numberOfTeams": 100,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 63,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.032258064516129,
        "numberOfProjects": 194,
        "growingSumLastWeekProjects": 30,
        "growingSumLastMonthProjects": 123,
        "growingPerDayLastWeekProjects": 4.285714285714286,
        "growingPerDayLastMonthProjects": 3.967741935483871,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 32,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 3017,
        "popularity": 98.5742,
        "unitSpace": "MB"
    },
    {
        "id": "c37d4829-b547-4c8d-b031-ffd2101b7c54",
        "dbServerName": "k2222.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,
        "dbSpaceUsed": 19011,
        "growingSumLastWeekSpaceUsed": 2114,
        "growingSumLastMonthSpaceUsed": 9595,
        "growingPerDayLastWeekSpaceUsed": 302,
        "growingPerDayLastMonthSpaceUsed": 309.51612903225805,
        "growingDaysLastMonth": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 780989,
        "dbSpaceRemainingPercentage": 97.6,
        "numberOfTeams": 101,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 68,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.193548387096774,
        "numberOfProjects": 147,
        "growingSumLastWeekProjects": 26,
        "growingSumLastMonthProjects": 96,
        "growingPerDayLastWeekProjects": 3.7142857142857144,
        "growingPerDayLastMonthProjects": 3.096774193548387,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 26,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 4447,
        "popularity": 98.16266,
        "unitSpace": "MB"
    }
]

...

Deck of Cards

id	bimGetDBServer

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/dbserverstatistics/<server_id>

URL: https://api-stage.bimplus.net/v2/administration/dbserverstatistics/<server_id>

Example: https://api-stage.bimplus.net/v2/administration/dbserverstatistics/cccbcbd4-df39-4b5c-9d55-257d15b6f2f2

Card

label	HTTP Method

GET

Card

label	Description

Retrieves the details of a particular database server. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "cccbcbd4-df39-4b5c-9d55-257d15b6f2f2",
    "dbServerName": "k2222.ims-firmen.de",
    "dbServerStatus": "Active",
    "usageStatisticsIsWorking": true,
    "dbServerIsClosed": false,
    "dbSpaceTotal": 800000,
    "dbSpaceUsed": 24603,
    "growingSumLastWeekSpaceUsed": 2717,
    "growingSumLastMonthSpaceUsed": 14853,
    "growingPerDayLastWeekSpaceUsed": 388.14285714285717,
    "growingPerDayLastMonthSpaceUsed": 479.1290322580645,
    "growingDaysLastMonth": 31,
    "growingDaysLastWeek": 7,
    "dbSpaceRemaining": 775397,
    "dbSpaceRemainingPercentage": 96.9,
    "numberOfTeams": 100,
    "growingSumLastWeekTeams": 12,
    "growingSumLastMonthTeams": 63,
    "growingPerDayLastWeekTeams": 1.7142857142857142,
    "growingPerDayLastMonthTeams": 2.032258064516129,
    "numberOfProjects": 194,
    "growingSumLastWeekProjects": 30,
    "growingSumLastMonthProjects": 123,
    "growingPerDayLastWeekProjects": 4.285714285714286,
    "growingPerDayLastMonthProjects": 3.967741935483871,
    "numberOfProjectsMin": 0,
    "numberOfProjectsMax": 32,
    "teamDbSpaceMin": 20,
    "teamDbSpaceMax": 3017,
    "popularity": 98.5742,
    "unitSpace": "MB",
    "adminLog": []
}

...

Deck of Cards

id	bimDBMove

HTTP Method

Card

label

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/teams/<team_id>/move

URL: https://api-stage.bimplus.net/v2/administration/teams/<team_id>/move

Example: https://api-stage.bimplus.net/v2/administration/teams/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/move

JSON Structure:

Name	Mandatory / Optional	Type	Description
targetServerId	mandatory	string	The id of the target db server
adminId	optional	string	The id of the shop admin who has moved the db

Card

label	HTTP Method

PUT

Card

label	Description

Move the database from one server to another. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "targetServerId": "cfb2e0fb1d-a8f7-45d8e-ad1e-11c341ab4a53zu",
    "adminId": "662835-9f5b-961fer-84b9-4dbdcc0ac1"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "publicRead": false,
    "publicWrite": false,
    "teamDbName": "BimPlus.Tenant.Dev.jay-company",
    "payment": null,
    "lastLogin": "0001-01-01T00:00:00",
    "failedLogins": 0,
    "owner": {
        "id": "e0ac3b-fa49-e540-ac2f-8ca3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en",
        "wrongLogins": 0
    },
    "invitees": 2,
    "teamMembers": [
        {
            "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "jayaraj.purushothaman@bimplus.net",
            "roleName": null,
            "invitationStatus": null
        },
        {
            "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "ssudha84@gmail.com",
            "roleName": null,
            "invitationStatus": null
        }
    ],
    "adminLog": [
        {
            "id": "996b1cb5-8942-4f60-91e9-a2cb00c975ca",
            "action": "Disabled",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T11:13:29.6298927"
        },
        {
            "id": "e3f5f3d7-e174-4a39-9078-a2cb00b65726",
            "action": "Active",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T10:03:52.8723593"
        },
        {
            "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
            "action": "Disabled",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:14.7675944"
        },
        {
            "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
            "action": "Active",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:01.0644085"
        }
    ],
    "id": "c3018713-a313-4bab-a952-2fddb58fb171",
    "slug": "jay-company",
    "name": "Jay Company",
    "server": "k1234.ims-firmen.de",
    "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "status": "Disabled",
    "countMembers": 3,
    "countProjects": 1,
    "usedSpace": 135
}

...

POST

Deck of Cards

id	bimCreateMessage

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages

Example: https://api-stage.bimplus.net/v2/messages

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string	Id of the message
receiver	mandatory	object	receiver user object (contains id & email)
sender	optional	object	sender user object (contains id & email)
id	mandatory	string(guid)	id of the user
email	mandatory	string	email id of the user
source	mandatory	string	Source of the message (eg: Import Service)
topic	mandatory	string	Topic of the message
severity	mandatory	object	Severity can be Info, Warning, Error
returnCode	mandatory	string	Readable return code
timestamp	will be ignored	string	Creation date of the message
unread	mandatory	boolean	Whether the message was unread
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

Card

label	HTTP Method

POST

Card

label	Description

Create a new message for an user.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
    },
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unread": false,
    "timestamp": "2013-11-15T10:55:53"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

...

Deck of Cards

id	bimGetCurrentMessageList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: user/<user_id>/messages

URL: https://api-stage.bimplus.net/v2/user/<user_id>/messages

Example: https://api-stage.bimplus.net/v2/user/123456789/messages

Card

label	HTTP Method

GET

Card

label	Description

Gets the message list of the current user

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

...

Deck of Cards

id	bimGetMessageListOfAll

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/user/messages

Example: https://api-stage.bimplus.net/v2/messages

Card

label	HTTP Method

GET

Card

label	Description

Gets the message list of the current user

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer3@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

...

GET

Deck of Cards

id	bimGetMessage

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified message

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
    },
    "source": "ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "returncode": "OK",
    "timestamp": "2013-11-18T14:30:53",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}

...

Deck of Cards

id	bimDeleteMessage

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified message.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

HTTP Method

Deck of Cards

id	bimMessageRead

Card

label

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasread

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Card

label	HTTP Method

POST

Card

label	Description

Mark a message as read.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Deck of Cards

id	bimGetMessageList

HTTP Method

Card

label

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26<property><operator><value>%26<property><operator><value>%26....

URL: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

Example: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26sourcenet%26source=IssueService

where "%26" is the escape character for "&"

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified message

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "44ad058b-1f76-4343-bafa-031eb462215c",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:17",
        "unread": true,
        "correlationId": null
    },
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED",
        "timestamp": "2014-04-08T08:54:41",
        "unread": true,
        "correlationId": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
    },
    {
        "id": "ffd50096-fb82-4029-8d49-06a04e31f02a",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser2@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:27",
        "unread": true,       
        "correlationId": null
    }
]

...

Deck of Cards

id	bimGetAllLog

HTTP Method

Card

label

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: logs

URL: https://api-stage.bimplus.net/v2/logs

Example: https://api-stage.bimplus.net/v2/logs

Card

label	HTTP Method

GET

Card

label	Description

Retrieves the whole log information from the beginning of the time.

Info
It is always better to use the other log API call which retrieves the log info between the time interval as this API will cause serious bandwidth usage

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": "", 
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },.....]

...

GET

Deck of Cards

id	bimGetLogTime

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: logs

URL: https://api-stage.bimplus.net/v2/logs/<startDate>/<endDate>

Example: https://api-stage.bimplus.net/v2/logs/20130101/20130102

OR

https://api-stage.bimplus.net/v2/logs/201301011200/201301011400

Card

label	HTTP Method

GET

Card

label	Description

Retrieves the log information between the mentioned time interval. The time interval could be either date based(eg: between 01.01.2013,02.01.2013) or time based (between 01.01.2013 12:00, 01.01.2013 14:00)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },.....]

...

Deck of Cards

id	bimGetObjectNavigatorList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectview

Example: https://api-stage.bimplus.net/v2/bimplus/objectview

Card

label	HTTP Method

GET

Card

label	Description

Get the list of target objectviews which will be populated in the "Object Navigator List"

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Room",
        "resourcenameid": "Category.ElementRoom",
        "iconid": "IconArchitectureRoom",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Finish",
        "resourcenameid": "Category.ElementFinish",
        "iconid": "IconRoofLayer",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Reinforcement",
        "resourcenameid": "Category.Reinforcement",
        "iconid": "IconReinforcement",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Mesh",
        "resourcenameid": "Category.Mesh",
        "iconid": "IconMesh",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Precast",
        "resourcenameid": "Category.PrecastElement",
        "iconid": "IconPrecastUnit",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_PrecastTimber",
        "resourcenameid": "Category.ElementPrecastTimber",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_MEP",
        "resourcenameid": "Category.ElementMEP",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Plumbing",
        "resourcenameid": "Category.ElementPlumbing",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Electricity",
        "resourcenameid": "Category.ElementElectricity",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Mechanical",
        "resourcenameid": "Category.ElementMechanical",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Construction",
        "resourcenameid": "Category.ElementConstruction",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Terrain",
        "resourcenameid": "Category.ElementTerrain",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Inventary",
        "resourcenameid": "Category.ElementInventary",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Structural",
        "resourcenameid": "Category.ElementStructural",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Clash",
        "resourcenameid": "Category.Collision",
        "iconid": "IconCollision",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Collision"
    },
    {
        "viewname": "onProjectIssues",
        "resourcenameid": "Category.Issue",
        "iconid": "IconIssue",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Issue"
    }
]

...

Deck of Cards

id	bimGetObjectNavigatorItem

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview/<objectview_name>name>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectview/<objectview_name>

Example: https://api-stage.bimplus.net/v2/bimplus/onProjectElements_Building

Card

label	HTTP Method

GET

Card

label	Description

Get information about a particular objectview

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    }
]

...

Deck of Cards

id	bimGetObjectListColumns

label

Card

HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview/<objectview_name>/tablecolumnstablecolumns

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectview/<objectview_name>/tablecolumns

Example: https://api-stage.bimplus.net/v2/bimplus/objectview/onProjectElements_Building/tablecolumns

Card

label	HTTP Method

GET

Card

label	Description

Get the properties(column names) of a particular objectview

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "name": "ObjectID",
        "ordernr": 1,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Nr",
        "ordernr": 2,
        "datatype": "int",
        "isdefault": null,
        "categorynameid": "Category.General",
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Name",
        "ordernr": 3,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Name",
        "proporder": null,
        "converter": "Converter_PPName",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Description",
        "ordernr": 4,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Description",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionID",
        "ordernr": 5,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Division",
        "ordernr": 6,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Model",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ModelType",
        "ordernr": 7,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Discipline",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ElementTyp",
        "ordernr": 8,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Type",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Weight",
        "ordernr": 9,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Mass",
        "proporder": null,
        "converter": "Converter_Mass",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Volume",
        "ordernr": 10,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Volume",
        "proporder": null,
        "converter": "Converter_Volume",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Area",
        "ordernr": 11,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Area",
        "proporder": null,
        "converter": "Converter_Area",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Length",
        "ordernr": 12,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Length",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Width",
        "ordernr": 13,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Width",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    }
]

...

POST

Deck of Cards

id	bimGetDetailsFromObjectList

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectview/tablecontent

URL: https://api-stage.bimplus.net/v2/<team_slug>objectview/tablecontent

Example: https://api-stage.bimplus.net/v2/bimplus/objectview/tablecontent

JSON Structure:

Name	Mandatory / Optional	Type	Description
tablename	mandatory	string	Name of the table
elementsId	mandatory	object	List of object id's whose details has to be found
filterColumns	optional	object	The properties that could be used as filters

Card

label	HTTP Method

POST

Card

label	Description

Get the required objectview's details from input object list reference

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "tablename": "onProjectElements_Building",
    "elementsguid": [
        "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
        "54978C4C-B18B-4420-819D-405234FC11B4",
        "EB0472BE-1353-4E47-BE76-875924E0586F"
    ],
    "filterColumns": [
        "ObjectId",
        "DivisionId",
        "Name",
        "Width",
        "ElementTyp"
    ]
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    }
]

...

Deck of Cards

id	bimCreateObjectView

label

Card

HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objectviews

URL: https://api-stage.bimplus.net/v2/<team_slug>objectviews

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews

JSON Structure:

Name	Mandatory / Optional	Type	Description
viewName	mandatory	string	Name of the new user defined view

Card

label	HTTP Method

POST

Card

label	Description

Create a new objectview

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "tablename": "onProjectElements_Building",
    "elementsguid": [
        "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
        "54978C4C-B18B-4420-819D-405234FC11B4",
        "EB0472BE-1353-4E47-BE76-875924E0586F"
    ],
    "filterColumns": [
        "ObjectId",
        "DivisionId",
        "Name",
        "Width",
        "ElementTyp"
    ]
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    }
]

...

POST

Deck of Cards

id	bimGetAllUserHierarchies

Card

label	HTTP Method

Card

default	true
label	URL / Resource / JSON Structure

Resource: usersettings/heirarchy/all

URL: https://api-stage.bimplus.net/v2/<team_slug>usersettings/heirarchy/all

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchy/all

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleid	mandatory	guid	Id of the module
userid	mandatory	guid	Id of the user
category	optional	string	category name (default category is "ObjectNavigator")

Card

label	HTTP Method

POST

Card

label	Description

Get all the user hierarchies using the user & module information

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "moduleid": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
    "category": "ObjectNavigator"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_MEP]",
        "valuename": "onProjectElements_MEP",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
        "datasmallint": 0,
        "revision": null
    }
]

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 509

New Version 510

Key

Get the activation status and the status log for a team