Page History

Rights and Roles Service

...

Rights and Roles Templates

Rights and Roles

Rights and Roles Service

...

Rights and Roles Templates

Anchor

	createTeamRightsAndRolesTemplate
	createTeamRightsAndRolesTemplate

Create new right and roles template in team

Deck of Cards

id	bimCreateTeamRightsAndRolesTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Unique name of the project attribute template
description	optional	string	Short description of the project attribute template

Card

label	HTTP Method

POST

Card

label	Description

Creates a new project attribute template.

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": "My project attribute template",
  "description": "Project attribute template for my team",
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My project attribute template",
  "description": "Project attribute template for my team",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	getTeamRightsAndRolesTemplates
	getTeamRightsAndRolesTemplates

Get the list of existing rights and roles templates in team

Deck of Cards

id	bimGetTeamRightsAndRolesTemplates

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get all the project attribute templates that belongs to a team. Each team has at least one default project attribute template.

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": "Default",
    "description": "Default project attribute template",
    "id": "0149c4a8-4e84-4c40-bfdd-5dd63b109266"
  },
  {
    "name": "My project attribute template",
    "description": "Project attribute template for my team",  
    "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
  }
]

Anchor

	getRightsAndRolesTemplateInfo
	getRightsAndRolesTemplateInfo

Get the info about a particular rights and roles template

Deck of Cards

id	bimGetRightsAndRolesTemplateInfo

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates/49d13da3-2acf-4f0b-b667-40fc0197585f

Card

label	HTTP Method

GET

Card

label	Description

Get the info about a particular project attribute template that belongs to a particular 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

 {
    "name": "My project attribute template",
    "description": "Project attribute template for my team",  
    "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
 }

Anchor

	updateTeamRightsAndRolesTemplate
	updateTeamRightsAndRolesTemplate

Update a particular rights and roles template

Deck of Cards

id	bimUpdateTeamRightsAndRolesTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates/49d13da3-2acf-4f0b-b667-40fc0197585f

JSON Structure: See Create project attribute template

Card

label	HTTP Method

PUT

Card

label	Description

Update a particular project attribute template that belongs to a particular team.

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": "My project attribute template2",
    "description": "Project attribute template for my team2",  
 }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "My project attribute template2",
  "description": "Project attribute template for my team2",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
}

Anchor

	deleteTeamRightsAndRolesTemplate
	deleteTeamRightsAndRolesTemplate

Delete the rights and roles template

Deck of Cards

id	bimDeleteTeamRightsAndRolesTemplate

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectattributetemplates

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

Example: https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates/49d13da3-2acf-4f0b-b667-40fc0197585f

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes the specific project attribute template.

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

	copyContentRightsAndRolesTemplate
	copyContentRightsAndRolesTemplate

Copy content rights and roles template from source to target rights and roles template

Deck of Cards

id	bimCopyContentRightsAndRolesTemplate

Card

label	Url / Resource /Json

Resource: projectattributetemplates/<targetprojectattributetemplates_id>/copyfrom

URL: https://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplates/<targetprojectattributetemplates_id>/copyfrom

Example:https://api-stage.bimplus.net/v2/bimplus/projectattributetemplates/49d13da3-2acf-4f0b-b667-40fc0197585f/copyfrom

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	will be ignored	string	Name of the project attribute template
description	will be ignored	string	Description of the project attribute template
id	mandatory	string(guid)	Unique guid of the source project attribute template

Card

label	HttpMethod

PUT

Card

label	Description

Updates the specified target project attribute template with all attribute templates from source project attribute template.
When project attribute template id is missing will be used internally default project attribute template (Guid as "0149c4a8-4e84-4c40-bfdd-5dd63b109266") as a source project attribute template.

Note:
In case when some attribute templates are already assigned to target project attribute template and the same attribute template is present also in source project attribute template,
in such case attribute templates will be added to target project attribute template.

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": "Default",
    "description": "Default project attribute template",
    "id": "0149c4a8-4e84-4c40-bfdd-5dd63b109266"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Rights and Roles

Anchor

	getAllRoles
	getAllRoles

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 39

New Version 40

Key

Rights and Roles Service

Create new right and roles template in team

Get the list of existing rights and roles templates in team

Get the info about a particular rights and roles template

Update a particular rights and roles template

Delete the rights and roles template

Copy content rights and roles template from source to target rights and roles template