Page History

...

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

default	true
label	URL / Resource / JSON Structure

Optional query parameters

Name	Type	Default value	Description
groups	boolean	false	When query parameter "groups=true" is defined, the API function returns all only group names to which is cross section definition assigned.

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"
            ]
        },
        {
            "resource": "UserRightLayer",
            "rights": [
                "MEPEdit"
            ]
        }
    ]
}

Anchor

	updateTheRole
	updateTheRole

Update the role

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

    "resources": 
	[ 
        {
            "resource": "UserRightLayer",
            "rights": 
			[
                 "MEP: 3"
                 
            ]
        }
    ]
}

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"
			]
		}
	]
}

Anchor

	deleteTheRole
	deleteTheRole

Delete the role

Deck of Cards

id	bimDeleteTheRole

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

DELETE

Card

label	Description

Deletes 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

Anchor

	assignProjectRole
	assignProjectRole

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version 9

Key

Update the role

Delete the role