Page History

Versions Compared

Old Version 1

changes.mady.by.user Jayaraj Purushothaman

Saved on May 27, 2015

compared with

New Version Current

changes.mady.by.user Peter Balogh

Saved on Sep 20, 2022

Key

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

secured using the application_id of portal

Team Management Service

...

Team Management Service

...

Anchor

	createTeam
	createTeam

Please remember that creating/updating/deleting a team is possible only for the clients who has the permission to do it.

Create a new team and its related database

Deck of Cards

id	bimCreateNewTeam

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

~~optional~~	~~string~~	~~The unique name which will be used in the url. If not set, server will generate it from the team's name.~~
name	mandatory	string	Name of the team
displayname

mandatory

will be ignored	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 (MB)~~	~~The total storage allocated to the the team (the initial storage size as ordered in the shop)~~ obsolete since 2016
storageStats	will be ignored	integer	The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
status	will be ignored	string	Active /

Inactive

Disabled
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 (json)

Public read/write rights

read

. Has two boolen properties : "read" and "write".
rights	optional

boolean

Read right (viewer right to all the projects under this team to all the registered users)

object (json)	Project rights. It's a json with only one boolean property "projectCreate", which defines whether a user can create a project for this team.
accountType	optional	string	Account type e.g. "Free", "Premium", ...
ismyteam

writeoptionalbooleanWrite right (write right to all the projects under this team to all the registered users)rightsobjectobjectProject rightsprojectCreate

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)

Is this team the user's team - true/false

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

lang

borderColor	Green
lang	xml
title	Headers	xml

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

Code Block

borderColor	Red
lang	xml
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
lang	xml
title	Status	lang	xml

Status: 201 Created

Code Block

borderColor	Red
titlelang	JSONxml
langtitle	xmlJSON

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "displayname" : "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",
    "haswriteaccessismyteam": falsetrue,
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Anchor

	getTeamInfo
	getTeamInfo

Get information about the team

Deck of Cards

id	bimGetTeamInfo

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

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
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
    }  
}

Anchor

	updateTeam
	updateTeam

Update information about the team

Deck of Cards

id	bimUpdateTeamInfo

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: See Create team

Name

Card
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

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

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

Code Block

borderColor	Red
lang	xml
title	JSON

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	deleteTeam
	deleteTeam

Delete the team

Deck of Cards

id	bimDeleteTeam

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

Card

label	Description

Update information about a specified team. Please remember that this service can be used only by the shop/portal Shop Portal or Connect Portal (secured using the application_id of portalspecial Shop or Connect Admin token)

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers	lang	xml

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

Card

label	Response

Code Block

borderColor	RedGreen
titlelang	JSONxml
langtitle	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Status

Status: 200 OK

Anchor

	getTeamsFromCurrentUser
	getTeamsFromCurrentUser

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

Deck of Cards

id	bimGetTeamFromCurrentUser

Card

...

Delete the team

Deck of Cards

id	bimDeleteTeam

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_slug> teams

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

GET

Card

label	HTTP Method	Description

Get a team list in which the current logged in user is a member of 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)

Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Status: 200 OK

Code Block

...

borderColor	Red

...

lang

...

xml
title	JSON

[
    {
        "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
        "slug": "best-company",
        "name": "Best Company",
        "displayname": "Best Company (best-company)",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

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

Deck of Cards

id	bimGetTeamFromCurrentUser

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",
        "slugstatus": "best-companyActive",
        "nameteamWorksConnection": "Best CompanyRGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "displaynamedataStorageStatus": "Best Company (best-company)Online",
        "ownerismyteam": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
true,
        "totalStoragerights": 500000000,
{
            "storageStatsprojectCreate": null,true
         "status": "Active"}
    },
    {
        "teamWorksConnectionid": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==82884f54-96bf-4e9c-a2fb-44db8379378d",
        "dataStorageStatusslug": "Onlinenemetschek",
        "ismyteamname": true"Nemetschek",
        "rightsdisplayname": {
   "Nemetschek (nemetschek)",
         "projectCreateowner": true"132a78a5-b523-4bf2-8382-7098fac3f803",
        }
    },
    {"status": "Active",
        "idteamWorksConnection": "82884f54-96bf-4e9c-a2fb-44db8379378dRGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
        "slugdataStorageStatus": "nemetschekOnline",
        "nameismyteam": "Nemetschek"false,
        "displaynamerights": "Nemetschek (nemetschek)",
 {
            "ownerprojectCreate": "132a78a5-b523-4bf2-8382-7098fac3f803",
false
        }
 "totalStorage": 0   },
    {
        "id": "7eab1453-a4e7-4d05-983e-031544540e6f",
        "storageStatsslug": null"bimplus-demo",
        "statusname": "ActiveBimPlusDemo",
        "displayname": "BimPlusDemo (bimplus-demo)",
        "owner": "5592c628-588e-f5c0-b08b-088d43de9209",
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    }
]

Anchor

	getAccountSettings
	getAccountSettings

Get team account settings

Deck of Cards

id	bimGetTeamAccountSettings

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>/accountsettings

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

Example: https://api-stage.bimplus.net/v2/administration/teams/f4b1178d-385f-449c-a2a7-6f58b264d90c/accountsettings

Card

label	HTTP Method

GET

Card

label	Description

Get account settings of given team.

Predefined account settings are :

MaxProjects - maximum number of projects in the team
MaxTeamMembers - maximum number of team members
CreateRevisions - are revisions activated in the projects of this team
ClashDetection - is clash detection functionality allowed
...

It is also possible to filter the list of account settings, using query parameter "settingName", e.g. :

https://api-stage.bimplus.net/v2/administration/teams/f4b1178d-385f-449c-a2a7-6f58b264d90c/accountsettings?settingName=ClashDetection&settingName=CreateRevisions

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

[ "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
  {
      "dataStorageStatusid": "Online826668e2-346b-4d5b-baf1-075e0b59dff5",
        "ismyteamteamId": false"31cb1181-2cbc-49dc-883a-0620e20140a4",
        "rightssettingName": {
        "ClashDetection",
    "projectCreatevalue": false"true",
        }"expirationDate": "2016-11-04T00:00:00"
    },
    {
    "id": "78a9550e-54d6-4618-be00-203d8be68b05",
    "idteamId": "7eab145331cb1181-a4e72cbc-4d0549dc-983e883a-031544540e6f0620e20140a4",
    "settingName": "MaxProjects",
    "slugvalue": "bimplus-demo20",
        "nameexpirationDate": "BimPlusDemo",null
  },
  {
    "displaynameid": "BimPlusDemo (bimplus-demo)455b1bf9-fbdf-4a13-9fae-92ca659d06a0",
        "ownerteamId": "5592c62831cb1181-588e2cbc-f5c049dc-b08b883a-088d43de92090620e20140a4",
        "totalStoragesettingName": 53687091200"MaxTeamMembers",
        "storageStatsvalue": null"10",
        "statusexpirationDate": "Active",null
  },
  {
    "teamWorksConnectionid": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
    42228d13-a4e7-4586-99cc-ae3791580842",
    "dataStorageStatusteamId": "Online31cb1181-2cbc-49dc-883a-0620e20140a4",
        "ismyteamsettingName": false"CreateRevisions",
        "rightsvalue": {
  "true",
          "projectCreate"expirationDate": false
        }
  null
  }
]

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Team Management Service

Team Management Service

Create a new team and its related database

Get information about the team

Update information about the team

Delete the team

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

Delete the team

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

Get team account settings