Page History

...

Deck of Cards

id	bimGetAllRoles

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

Optional query parameters

Name	Type	Default value	Description
rights	boolean	true	When query parameter "rights=false" is defined, the API call will returns all roles. i.e. not only roles which contains resources and right definitions. When query parameter is missing, the API call returns only roles which includes resources and rights definitions.
customrole	boolean		When query parameter customrole is defined e.g. "customrole=true", the API call will returns only roles which have value of property "customRole" equal to query parameter. When query parameter is missing, the API call returns all roles (i.e. their customRole property can be true or false)

Card

label	HTTP Method

GET

Card

label	Description

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

Here is the definition of Bimplus Rights and Roles.

	Account Owner	Project Admin	Project Editor	Project Viewer
Create project	x
Admin project	x	x
Delete project	x	x
Edit project	x	x	x
View project	x	x	x	x
Create model	x	x
View all models	x	x	x	x

Model rights and roles are not supported yet, the project rights are used instead - meaning e.g. update model requires ProjectEdit rights

The custom roles contains also definition for which resource and rights are valid.

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":"f11d32e201943654-30b7cac6-4f814502-8a74b640-2165ecc00cf6192f7a1f6a6d",
    "name":"Project_EditorTesdet",
    "customRole":true,
    "resources":[{
        "resourceid":"UserRightProject4e587ea1-5098-45cd-9655-15f90c16dc58",
        "rightsresource":["ProjectEditLayer",
          "Model_ViewAll",
          "Model_Createrights":["RoomModel"
        ],
      }  "rightsAccess":[{
    ]
  },
  {
    "id":"213becc052bbc329-ad48dab3-4cd0a81c-aef2b548-b922b21bbfd709c715786a81",
            "name":"TestRoleParentRoomModel",
      "customRole":true,
     "resources":[{
        "resource"access":"UserRightLayerEdit",
          "rights":["MEPEdit"}
        ]
      }
    ],
  },
  "children":[{
        "id":"d1310d52f11d32e2-addf30b7-42644f81-86238a74-29730d2cc7752165ecc00cf6",
        "parentname":"213becc0-ad48-4cd0-aef2-b922b21bbfd7Project_Editor",
    "customRole":true,
    "nameresources":"Testchild",[{
        "customRoleid":true,
        "resources":[{
    "4e587ea1-5098-45cd-9655-15f90c16dc58",
        "resource":"UserRightGlobalFreeAttributesLayer",
            "rights":["FreeAttributeViewDoorWindow",
        ],
        "FreeAttributeGroupViewrightsAccess",:[{
              "AttributeTemplateView"id":"8ba5ec82-5b93-6192-55b0-b7790f4d0007",
              "ProjectAttributeTemplateView""name":"DoorWindow",
            ]"access":"Edit"
          },
          {]
      },
      "resource":"UserRightLayer",{
            "rightsid":["MEPEdit""cc49128e-9416-4bfc-a695-b17365dc7a5e",
            ]"resource":"Project",
          }"rights":["ProjectView"
        ],
      },
  "rightsAccess":[{
    {
        "id":"118898b6815ce797-0b86da07-48764372-bb058a59-bf5294e392d6609f7106ab09",
        "parent":"213becc0-ad48-4cd0-aef2-b922b21bbfd7",
        "name":"TestRoleProject",
        "customRole":true,
        "resourcesaccess":[{"View"
            "resource":"UserRightGlobalFreeAttributes",}
            "rights":["FreeAttributeView",]
      }
    ]
    "FreeAttributeGroupView"},
              "AttributeTemplateView",
              "ProjectAttributeTemplateView"
            ]
          },
          {
            "resource":"UserRightLayer",
            "rights":["MEPEdit"
            ]
          }
        ]
      }
    ]
  }
]

...

...
]

Anchor

	getAllRights
	getAllRights

Get all the available rights

Deck of Cards

id	bimGetAllRights

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/rights

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

Example: https:

...

Get all the available rights

Deck of Cards

id	bimGetAllRights

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/rights

URL: https://api-stage.bimplus.net/v2/<team_slug>/rightsExample: https://api-stage.bimplus.net/v2/best-company/rights

Card

label	HTTP Method

GET

Card

label	Description

Get all the available rights.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	string (guid)	Id of the right resource type
resource	mandatory	string	The name of the right resource type
rights	mandatory	object	Dictionary of the pairs of right id together with its name
access	mandatory	JSON Array	Array of the strings represented access right. Can be combination of predefined rights "View", "Edit", "Admin"

Optional query parameters:
Following query parameters allows reduce set of returned right resource types. By default will be returned all defined right resource types.

Name	Type	Default value	Description
project	boolean	true	When query parameter "project=false" is defined, the API call will returns all right resource types except project right resource type.
global	boolean	true	When query parameter "global=false" is defined, the API call will returns all right resource types except global right resource type.
document	boolean	true	When query parameter "document=false" is defined, the API call will returns all right resource types except document right resource type.
globalfreeattributes	boolean	true	When query parameter "globalfreeattributes=false" is defined, the API call will returns all right resource types except globalfreeattributes right resource type.
layer	boolean	true	When query parameter "layer=false" is defined, the API call will returns all right resource types except layer right resource type.

Card

label	HTTP Method

GET

Card

label	Description

Get all the available rights returns array of right resource types with defined rights.

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 Ok

Code Block

borderColor	Red
lang	xml
title	JSON

[{
    "resource":"UserRightModel",
    "rights":["Model_Assign",
      "Model_Admin",
      "Model_Delete",
      "Model_Edit",
      "Model_View",
      "Model_Import"
    ]
  },
  {
    "resourceid":"UserRightProject4e587ea1-5098-45cd-9655-15f90c16dc58",
    "rightsresource":["Model_ViewAllLayer",
      "Model_Create",rights":{
      "Project_Right",
      "Project_AllDocuments"
    ]
  }231222ba-7495-f438-cf38-629cf0482364":"building",
  {
    "resourcedd9b9e2c-f4af-576f-4dda-9e122ab13d31":"UserRightGlobalgeneral objects",
      "rights92f8a361-5990-0cb0-b257-e13c85f0f7b1":["AllProjectsmep",
      "AllModels0047e2ed-3348-a97b-93d2-a6817cc9cb8e":"steel design",
      "Project_Delete"8095dfcf-fbdf-3317-b873-a7cbccccb206":"timber design",
      "Project_Createf7819a2d-1498-2468-b120-fdefedfccf0b":"terrain",
      "AllDocuments903fe394-5e84-5c8d-2760-eeadad3baa35":"reinforcement",
      "AllAttributes"44c2ff85-9691-6def-9583-56d8b776c846":"finish",
    ]
  }"6719f657-ea4a-3016-1bda-0c56c7f113d4":"inventory",
  {
    "resource52bbc329-dab3-a81c-b548-09c715786a81":"UserRightDocumentroom",
    "rights  "4a4da391-b804-b20f-f49a-470bdc68be8f":["Document_Update"structural analysis",
      "Document_Delete7f27fd11-7992-8fb5-3541-9daa4f8196b2":"opening",
      "Document_Share8ba5ec82-5b93-6192-55b0-b7790f4d0007":"door/window",
      "Document_DownloadDenied5c695e85-ea7c-7df4-9fb7-eca7aa1f69fd":"precast",
      "Document_ViewDenied""85d0b1a9-11bb-6de1-9cfd-54f85ee11da3":"bridge",
    ]
  }"d726e8d2-12c6-641d-b19d-37511349dce1":"structural loads",
  {
    "resource3517d0e2-9814-fc08-b3e7-59d453940efa":"UserRightGlobalFreeAttributes"connection"
    },
    "rightsaccess":["FreeAttributeEditView",
      "FreeAttributeGroupEditEdit",
    ]
  "AttributeTemplateEdit"},
  {
    "ProjectAttributeTemplateEdit"id":"173e7a88-16d9-4d88-92bf-270fff458435",
      "FreeAttributeView"resource":"Document",
      "FreeAttributeGroupViewrights",:{
      "AttributeTemplateView73ca755b-eb41-4abf-8d72-6360f638a34c":"documentshare",
      "ProjectAttributeTemplateViewf53dac0d-8ef8-48bd-9fa5-b49831bcf671":"documentdelete",
      "TeamMembershipEdit",
      "TeamMembershipView6513c54f-0531-47e2-853d-56a25a226765":"documentdownloaddenied",
      "StructuralAction_Editor820eb26b-7469-48bd-b10f-0c69e631c910":"documentviewdenied",
      "StructuralAction_Viewer","d7727bed-38b8-4a77-b61d-397fb01f1ad8":"documentupdate"
    },
  "Precast_Editor",  "access":["Edit"
    ]
  "Precast_Viewer"},
  {
    "Bridge_Editor"id":"cc49128e-9416-4bfc-a695-b17365dc7a5e",
      "Bridge_Viewer"resource":"Project",
      "DoorWindow_Editor",rights":{
      "DoorWindow_Viewer",815ce797-da07-4372-8a59-609f7106ab09":"project"
    },
  "Holzbauobjekte_Editor  "access":["View",
      "Holzbauobjekte_ViewerEdit",
      "BuildingModel_EditorAdmin",
    ]
  "BuildingModel_Viewer"},
  {
    "Opening_Editor"id":"9dae8bb5-77c1-47a6-a916-d4948583b0b9",
      "Opening_Viewer"resource":"Global",
      "Inventary_Editor",rights":{
      "Inventary_Viewer"c64151c5-ecde-4e2c-ba53-d0390f480461":"projectdelete",
      "TerrainModel_Editor6bbc401b-7cd5-4684-a11d-e2448befb3c1":"projectcreate",
      "TerrainModel_Viewer99bad6fc-0539-4848-84af-62b6df31eaa3":"allattributes",
      "Stahlbauobjekte_Editor",
      "Stahlbauobjekte_Viewer3b3f10c1-93a6-4d15-a727-e38e2fb9b0b2":"alldocuments",
      "MEP_Editorcc3416d3-c570-4dc6-aa84-72216d3f58da":"allmodels",
      "MEP_Viewer","9351251b-9631-499e-8e23-68ffe70ef3b7":"allprojects"
    },
    "CollisionModel_Editor","access":["Edit"
    ]
  "CollisionModel_Viewer"},
  {
    "Connection_Editor"id":"500766a6-2525-45db-b9cd-b2a3d8092ba9",
      "Connection_Viewer"resource":"GlobalFreeAttributes",
      "Proxy Model_Editor","rights":{
      "Proxy Model_Viewer"061a3842-9b4d-4d19-8651-2f9373c42842":"freeattribute",
      "Finish_Editor63b9bfad-db9f-4bbe-a902-7716c440a200":"attributetemplate",
      "Finish_Viewer04f5c272-3dec-4bce-85ae-6abb2e936ef8":"projectattributetemplate",
      "DesignModel_Concrete_Construction_Editor2a0e7bed-9fbf-46bc-987a-7a6c5c638f98":"freeattributegroup",
      "DesignModel_Concrete_Construction_Viewer",
      "Room_Editor",b886cab2-fcce-4a77-ab2d-09f704e363b7":"teammembership"
      "Room_Viewer"},
      "StructuralAnalysis_Editor",
      "StructuralAnalysis_Vieweraccess":["View",
      "RevisionComparison_EditorEdit",
      "RevisionComparison_Viewer"
    ]
  },
  {
    "resource":"UserRightLayer",
    "rights":["StructuralAction_Right",
      "Precast_Right",
      "Bridge_Right",
      "DoorWindow_Right",
      "Holzbauobjekte_Right",
      "BuildingModel_Right",
      "Opening_Right",
      "Inventary_Right",
      "TerrainModel_Right",
      "Stahlbauobjekte_Right",
      "MEP_Right",
      "CollisionModel_Right",
      "Connection_Right",
      "Proxy Model_Right",
      "Finish_Right",
      "DesignModel_Concrete_Construction_Right",
      "Room_Right",
      "StructuralAnalysis_Right",
      "RevisionComparison_Right"
    ]
  }
]

...

Anchor

	createNewRole
	createNewRole

Create a new role

Deck of Cards

id	bimCreateNewRole

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/bimplus/roles

JSON Structure

...

Create a new role

Deck of Cards

id	bimCreateNewRole

JSON Structure of the resource definition object:

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/bimplus/roles

JSON Structure:

Name

Mandatory / Optional

Type

Description

id

optional

string (guid)

Id of the role

name

mandatory

string

The name of the role

parent

optional

string (guid)

The Id of the parent role

customRole

mandatory

boolean

When this flag is true the role is custom role otherwise will role is 'built in' role

resources

mandatory

JSON Array

Array of the resource definition objects for which the role is valid

Name	Mandatory / Optional	Type	Description
resource	mandatory	string	Describe kind of right e.g. "UserRightGlobal" or "UserRightLayer"
rights	mandatory	JSON Array	Array of the strings of rights e.g.: "FreeAttributeView", "MEP: 2"

Card

label	HTTP Method

POST

Card

label	Description

Creates a new role with defined properties and resources to be valid for.

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

{
    "parent": "213becc0-ad48-4cd0-aef2-b922b21bbfd7",
    "name": "TestRole",
    "customRole": true,
    "resources": [
        {
            "resource": "UserRightGlobal",
            "rights": [
                "FreeAttributeView",
                "FreeAttributeGroupView",
                "AttributeTemplateView",
                "ProjectAttributeTemplateView"
            ]
        },
        {
            "resource": "UserRightLayer",
            "rights": [
                "MEP: 2"
            ]
        }
    ]
}


id	optional	string (guid)	Id of the role
name	mandatory	string	The name of the role
parent	optional	string (guid)	The Id of the parent role
customRole	optional	boolean	When this flag is true the role is custom role otherwise will role is 'built in' role
resources	optional	JSON Array	Array of the right resource type definition objects for which the role is valid

JSON Structure of the right resource type definition object:

Name	Mandatory / Optional	Type	Description
id	optional	string(Guid)	Id of the right resource type
resource	mandatory	string	Describe kind of right resource type e.g. Global" or "Layer", etc.
rights	mandatory	JSON Array	Array of the strings with right names e.g.: "FreeAttributeView", "RoomModel"
rightsAccess	mandatory	JSON Array	Array of the objects with properties id, name, access : id is string (Guid) represent id of right name is string representing name of right e.g. "RoomModel", access is string representing access right of the right e.g. "View"

Card

label	HTTP Method

POST

Card

label	Description

Creates a new role with defined properties and resources to be valid for.

Card

label	Request

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	StatusHeaders

StatusAuthorization: 201 CreatedBimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{{
    "id": "118898b6-0b86-4876-bb05-bf5294e392d6",
    "parent": "213becc0-ad48-4cd0-aef2-b922b21bbfd7",
    "name": "TestRoleTest",
    "customRole": true,
    "resources": [{
        {"id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
      "resource":"Layer",
      "resourcerights": ["UserRightGlobalRoomModel",
      ],
      "rightsrightsAccess": [{
                "FreeAttributeView",
   "id":"52bbc329-dab3-a81c-b548-09c715786a81",
             "FreeAttributeGroupView"name":"RoomModel",
                "AttributeTemplateView","access":"Edit"
        }
        "ProjectAttributeTemplateView"]
        }
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name":"Test",
  "customRole":true,
  "resources":[       },
        {
      "id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
      "resource": "UserRightLayerLayer",
            "rights": ["RoomModel"
      ],
          "MEPEdit"
            ]
 rightsAccess":[{
       }
    ]
}

...

   "id":"52bbc329-dab3-a81c-b548-09c715786a81",
          "name":"RoomModel",
          "access":"Edit"
        }
      ]
    }
  ]
}

Anchor

	getRoleDetails
	getRoleDetails

Get details of the role

Deck of Cards

id	bimGetRoleDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles/<role_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc0-ad48-4cd0-aef2-b922b21bbfd7

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified role.

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

{
  "name":"Test",
  "customRole":true,
  "resources":[{
      "id":"52bbc329-dab3-a81c-b548-09c715786a81",
      "resource":"UserRightLayer

...

Get details of the role

Deck of Cards

id	bimGetRoleDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles/<role_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc0-ad48-4cd0-aef2-b922b21bbfd7

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified role.

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": "118898b6-0b86-4876-bb05-bf5294e392d6",
    "parent": "213becc0-ad48-4cd0-aef2-b922b21bbfd7",
    "name": "Skuska2child",
    "customRole": true,
    "resources": [
        {
            "resource": "UserRightGlobalFreeAttributes",
            "rights": [
                "FreeAttributeView",
                "FreeAttributeGroupView",
                "AttributeTemplateView",
                "ProjectAttributeTemplateView"
    "rights":["Room"
        ]
        },
        "rightsAccess":[{
            "resourceid": "UserRightLayer"4e587ea1-5098-45cd-9655-15f90c16dc58",
            "rightsname": ["Room",
                "MEPEdit"access":"View"
        }
      ]
        }
    ]
}

Anchor

	updateTheRole
	updateTheRole

...

Deck of Cards

id	bimUpdateTheRole

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_slug>/roles/<role_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/roles/213becc0-ad48-4cd0-aef2-b922b21bbfd7

Json structure : See above in Create a new role section.

Card

label	HTTP Method

PUT

Card

label	Description

Update the role.

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": "Skuska2updateTest",
    "customRole": true,

    "resources": [{
	[ 
        {"id":"52bbc329-dab3-a81c-b548-09c715786a81",
      "resource":"UserRightLayer",
      "resourcerights": ["UserRightLayerRoom",
      ],
      "rightsrightsAccess": 
			[{
          "id":"4e587ea1-5098-45cd-9655-15f90c16dc58",
          "MEP: 3"name":"Room",
          "access":"View"
        }
            ]
        }
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
	"id": "213becc0-ad48-4cd0-aef2-b922b21bbfd7",
	"name": "Skuska2update",
	"customRole": true,
	"resources": [
		{
			"resource": "UserRightLayer",
			"rights": [
				"MEPAdmin"
			]
		}
	]
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 27

New Version 28

Key

Get all the available rights

Get all the available rights

Create a new role

Create a new role

Get details of the role

Get details of the role