Page History

...

Deck of Cards

id	bimUpdateProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	id of the project
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	date	Creation date of the project
changed	optional	date	Changed date of the project

Card

label	Description

Update or replace a specified existing project with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
"shortDescr" : "Updating the project"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Deck of Cards

id	bimObjectUpdate

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<company>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Id of the object

Name	Mandatory / Optional	Type	Description	id	mandatory	guid
parent	optional	guid	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional		Children of the object

Card

label	Description

Update or replace a specified existing object with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Deck of Cards

id	bimPinUpdate

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId		guid	The id of the issue to which the pin is related
objectId			The id of the object to which the pin is related
position	optional
normalVector	optional
createdAt	optional	date	The creation date

Card

label	Description

Update or replace a specified existing pin with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Deck of Cards

id	bimUpdateUserInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2//users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6<user_id>

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

JSON Structure:

Name	Type	Description
email	string	Email of the user
status	string
password	string	Password of the user

Card

label	Description

Update information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

...

Deck of Cards

id	bimGetCurrentUserInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

URL: https://api.bimplus.net/v2/<company>/user

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about the currently logged in user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

...

Deck of Cards

id	bimCreateNewTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

URL: https://api.bimplus.net/v2/<company>/teamsExample

JSON Structure: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Id of the team

Name	Mandatory / Optional	Type	Description
Name	Mandatory / Optional	Type	Description
id	optional	guid
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	guid	The unique identifier of the user who will be the initial owner
totalStorage	optional		The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	optional		The storage statistics of the team
status	optional	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Card

label	Description

Create a new team and its related database.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	StatusJSON

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get information about the team

...

{

        "slug": "best-company",
        "name": "Best Company",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online"
    }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

Deck of Cards

id	bimGetTeamInfo

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

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

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Get information about a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:
{
    {
"id": "c8c8e6f2db038754-44952598-484c4616-929d9ea2-0049f1f9d4ff2c0947f2e93a"
name,
    "slug": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

"best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online"
}

...

Get information about the team

...

Deck of Cards

id	bimUpdateTeamInfobimGetTeamInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUTGET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

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

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	optional	guid	Id of the team
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	guid	The unique identifier of the user who will be the initial owner
totalStorage	optional		The total storage allocated to the the team
storageStats	optional		The storage statistics of the team
status	optional	string
teamWorksConnection	optional	string
dataStorageStatus	optional	string

Card

label	Description

Update information about a specified team.

teams/db038754-2598-4616-9ea2-2c0947f2e93a

Card

label	Description

Get information about a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Update information about the team

...

Deck of Cards

id	bimGetTeamFromCurrentUserbimUpdateTeamInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GETPUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams teams/<team_id>

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

Example: https://api.bimplus.net/v2/bimplus/projects

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
lang	xml
title	Headers


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

teams/db038754-2598-4616-9ea2-2c0947f2e93a

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	guid	The unique identifier of the user who will be the initial owner
totalStorage	optional		The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	optional		The storage statistics of the team
status	optional	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Card

label	Description

Update information about a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

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

...

Deck of Cards

id	bimGetTeamFromCurrentUser

Card

label	Implementation Status

Image Added Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

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

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
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON


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

Membership Management Service

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key

Get information about the team

Get information about the team

Update information about the team

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

Membership Management Service