Versions Compared

Key

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

...

Rights and Roles Templates


Rights and Roles

...

Anchor
createTeamRightsAndRolesTemplate
createTeamRightsAndRolesTemplate

Create new project right and roles template

...

Deck of Cards
idbimCreateTeamRightsAndRolesTemplate


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projectattributetemplatesprojectrightsrolestemplates

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplatesprojectrightsrolestemplates

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

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Unique name of the project attribute templaterights and roles template 

description

optional

string

Short description of the project attribute rights and roles template



Card
labelHTTP Method
 POST


Card
labelDescription

Creates a new project attribute right and roles template.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
  "name": "My project rights and attributeroles template",
  "description": "Project attributerights templateand forroles mytemplate teamdescription",
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
  "id":"49d13da3-2acf-4f0b-b667-40fc0197585f",
  "name": "My project rights attributeand roles template",
  "description": "Project attributerights templateand forroles my team",
  "id": "49d13da3-2acf-4f0b-b667-40fc0197585ftemplate description"
}




Anchor
getTeamRightsAndRolesTemplates
getTeamRightsAndRolesTemplates

Get the list of existing project rights and roles templates

...

Deck of Cards
idbimGetTeamRightsAndRolesTemplates


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projectattributetemplates projectsrightsrolestemplates

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplatesprojectsrightsrolestemplates

Examplehttps://api-stage.bimplus.net/v2/bimplus/projectattributetemplatesprojectsrightsrolestemplates


Card
labelHTTP Method
 GET


Card
labelDescription
 Get Get all the project attribute rights and roles templates that belongs to a team. Each team has at least one default project attribute rights and roles template.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[
  {
    "nameid": "Default"49d13da3-2acf-4f0b-b667-40fc0197585f",
    "descriptionname": "DefaultMy project rights and attributeroles template",
    "iddescription":"Project rights and roles template "0149c4a8-4e84-4c40-bfdd-5dd63b109266"description"
  },
  {
    "nameid": "My project attribute template"1996f9a0-fe24-4dc7-8140-0cfb98d31442",
    "name":"CustomProjectRightsRolesTemplate",
    "description": "Project attributeCustom template for rights myand teamroles"
  },
  {
    "id": "49d13da3482176be-2acf84ab-4f0b4d8f-b667-40fc0197585f93e4-2c58863d4eae",
    "name":"DefaultProjectRightsRolesTemplate",
    "description":"Default template for rights and roles"
  }
]



Anchor
getRightsAndRolesTemplateInfo
getRightsAndRolesTemplateInfo

Get the info about a particular project rights and roles template
Deck of Cards
idbimGetRightsAndRolesTemplateInfo


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projectattributetemplatesprojectrightsrolestemplates

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplatesprojectsrightsrolestemplates/<projectattributetemplates<template_id>id> 

Examplehttps://api-stage.bimplus.net/v2/bimplus/projectattributetemplatesprojectsrightsrolestemplates/49d13da3-2acf-4f0b-b667-40fc0197585f


Card
labelHTTP Method
 GET


Card
labelDescription
Get the info about a particular project attribute rights and roles template that belongs to a particular team.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
 {
  "id":"49d13da3-2acf-4f0b-b667-40fc0197585f",
  "name": "My project rights and attributeroles template",
    "description": "Project attributerights templateand forroles mytemplate teamdescription",  
    "id": "49d13da3-2acf-4f0b-b667-40fc0197585f"
 }

...


}



Anchor
updateTeamRightsAndRolesTemplate
updateTeamRightsAndRolesTemplate

...

U
pdate a particular project rights and roles template
Deck of Cards
idbimUpdateTeamRightsAndRolesTemplate


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projectattributetemplatesprojectrightsrolestemplates

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplatesprojectrightsrolestemplates

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

JSON Structure: See Create project attribute rights and roles template


Card
labelHTTP Method
 PUT


Card
labelDescription
 Update a particular project attribute rights and roles template that belongs to a particular team.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
    "name": "My project attribute template2 rights and roles template 2",
    "description": "Project attributerights and roles template fordescription my team2",  
 2"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
  "nameid": "My project attribute template2"49d13da3-2acf-4f0b-b667-40fc0197585f",
  "descriptionname":"My "Projectproject attributerights templateand forroles mytemplate team22",
  "iddescription": "49d13da3-2acf-4f0b-b667-40fc0197585f"Project rights and roles template description 2"
}



Anchor
deleteTeamRightsAndRolesTemplate
deleteTeamRightsAndRolesTemplate

Delete the project rights and roles template
Deck of Cards
idbimDeleteTeamRightsAndRolesTemplate


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projectattributetemplatesprojectrightsrolestemplates

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplatesprojectrightsrolestemplates

Examplehttps://api-stage.bimplus.net/v2/bimplus/projectattributetemplatesprojectrightsrolestemplates/49d13da3-2acf-4f0b-b667-40fc0197585f


Card
labelHTTP Method
 DELETE


Card
labelDescription
 Deletes the specific project attribute rights and roles template.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor
copyContentRightsAndRolesTemplate
copyContentRightsAndRolesTemplate

Copy content project rights and roles template from source to target project rights and roles template
Deck of Cards
idbimCopyContentRightsAndRolesTemplate


Card
labelUrl / Resource /Json

Resource: projectattributetemplatesprojectrightsrolestemplates/<targetprojectattributetemplates<targetprojectrightsrolestemplates_id>/copyfrom

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectattributetemplatesprojectrightsrolestemplates/<targetprojectattributetemplates<targetprojectrightsrolestemplates_id>id>/copyfrom

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

JSON Structure 

Name

Mandatory / Optional

Type

Description

name

will be ignored

string

Name of the project attribute rights and roles template

description

will be ignored

string

Description of the project attribute rights and roles template

idmandatorystring(guid)Unique guid of the source project attribute rights and roles template

 


Card
labelHttpMethod

PUT


Card
labelDescription

Updates the specified target project attribute rights and roles template with all attribute templates roles from source project attribute rights and roles template.
When project attribute rights and roles template id is missing will be used internally default project attribute right and roles template (Guid as "0149c4a8482176be-4e8484ab-4c404d8f-bfdd93e4-5dd63b1092662c58863d4eae") as a source  project attribute source project right and roles template.

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


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
    "name": "Default",
    "description": "Default project attribute template",
    "id": "0149c4a8482176be-4e8484ab-4c404d8f-bfdd93e4-5dd63b1092662c58863d4eae"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus


Code Block
borderColorRed
langxml
titleJSON
{
  "id":"49d13da3-2acf-4f0b-b667-40fc0197585f",
  "name":"My project rights and roles template",
  "description":"Project rights and roles template description"
}





Rights and Roles

Anchor
getAllRoles
getAllRoles

...