Skip to main content

PermissionPageResult

totalintegerrequired

Total number of items

result object[]required

Array of permission items

  • Array [
  • uidstringrequired

    Unique identifier of the permission

    typestringrequired

    Type of the permission

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

    subTypestring

    Subtype of the permission

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

    codestringrequired

    Code of the permission

    labelstringrequired

    Display label of the permission

    descriptionstring

    Description of the permission

    metadata objectrequired
    urlstring

    URL of the resource held by this permission

    logo object
    formatstring

    Format of the logo

    resourcestring

    Resource of the logo

    thematic object
    uidstringrequired

    Unique identifier of the thematic

    names objectrequired

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

    property name*string
    orderintegerrequired

    Display order of the thematic

    children objectrequired
    countintegerrequired

    Total number of children

    uidsstring[]required

    UIDs of child permissions

    users object
    countintegerrequired

    Total number of users

  • ]
  • PermissionPageResult
    {
    "total": 0,
    "result": [
    {
    "uid": "string",
    "type": "ASSET",
    "subType": "BUILDING",
    "code": "string",
    "label": "string",
    "description": "string",
    "metadata": {
    "url": "string",
    "logo": {
    "format": "string",
    "resource": "string"
    },
    "thematic": {
    "uid": "string",
    "names": {},
    "order": 0
    }
    },
    "children": {
    "count": 0,
    "uids": [
    "string"
    ]
    },
    "users": {
    "count": 0
    }
    }
    ]
    }