PermissionPageResult

totalintegerrequired

Total number of items

Example: 42

result object[]required

Array of permission items

Array [

uidstringrequired

Unique identifier of the permission

Example: 019619df-4768-76b3-8ab3-4414dcf29ff1

typestringrequired

Type of the permission

Possible values: [ASSET, PROFILE, SCOPE, SCOPE_GROUP, REPORT, REPORT_GROUP]

Example: ASSET

subTypestring

Subtype of the permission

Possible values: [BUILDING, BUILDING_GROUP, FACILITY, PORTFOLIO, COMPANY, APPLICATION, RIGHT, POWERBI, METABASE]

Example: PORTFOLIO

codestringrequired

Code of the permission

Example: portfolio-123

labelstringrequired

Display label of the permission

Example: Alpha Portfolio

descriptionstring

Description of the permission

Example: The Alpha Portfolio of buildings

metadata objectrequired

urlstring

URL of the resource held by this permission

Example: https://example.com

logo object

formatstring

Format of the logo

Example: SVG

resourcestring

Resource of the logo

Example: <svg></svg>

thematic object

uidstringrequired

Unique identifier of the thematic

Example: 550e8400-e29b-41d4-a716-446655440000

names objectrequired

Localized names of the thematic (locale as key, name as value)

property name*string

orderintegerrequired

Display order of the thematic

Example: 1

assetCodestring

Asset ERP code associated with this permission (for ASSET type permissions)

Example: ASSET-001

children objectrequired

countintegerrequired

Total number of children

Example: 5

uidsstring[]required

UIDs of child permissions

Example: ["019619df-4767-730f-8d31-143712a08141","019619df-4768-75e4-a334-cde454b9e9e1"]

users object

countintegerrequired

Total number of users

Example: 3

]

PermissionPageResult

{
  "total": 42,
  "result": [
    {
      "uid": "019619df-4768-76b3-8ab3-4414dcf29ff1",
      "type": "ASSET",
      "subType": "PORTFOLIO",
      "code": "portfolio-123",
      "label": "Alpha Portfolio",
      "description": "The Alpha Portfolio of buildings",
      "metadata": {
        "url": "https://example.com",
        "logo": {
          "format": "SVG",
          "resource": "<svg></svg>"
        },
        "thematic": {
          "uid": "550e8400-e29b-41d4-a716-446655440000",
          "names": {
            "en-GB": "Environmental Sustainability",
            "fr-FR": "Durabilité Environnementale"
          },
          "order": 1
        },
        "assetCode": "ASSET-001"
      },
      "children": {
        "count": 5,
        "uids": [
          "019619df-4767-730f-8d31-143712a08141",
          "019619df-4768-75e4-a334-cde454b9e9e1"
        ]
      },
      "users": {
        "count": 3
      }
    }
  ]
}