REST API for Oracle Analytics Server

Get catalog item ACL

post

/api/20210901/catalog/{type}/{id}/actions/getACL

Get the access control list (ACL) for a catalog item with a given id.

Request

Path Parameters

id(required): string

Catalog item ID in base64url format.
type(required):

Type of catalog item. The content types that this API supports include folders, workbooks, subject areas, analyses, dashboards, dashboard pages, reports, connections, datasets, data flows, sequences, scripts, and semantic models.

Supported Media Types

Root Schema : schema

Type: string

Allowed Values:

[
    ""
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : CatalogItemACLs

Type: array

Show Source

Array of: object CatalogItemACL

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CatalogItemACL"
    }
}

Nested Schema : CatalogItemACL

Type: object

Show Source

accountDisplayName: string

Display name for the user or application role, if available.
accountGuid(required): string

User ID or application role name.
accountType(required): accountType
permissions: permissions

{
    "type":"object",
    "properties":{
        "accountGuid":{
            "type":"string",
            "description":"User ID or application role name."
        },
        "accountType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AccountType"
                },
                {
                    "description":"User or ApplicationRole."
                }
            ]
        },
        "accountDisplayName":{
            "type":"string",
            "description":"Display name for the user or application role, if available."
        },
        "permissions":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Permissions"
                },
                {
                    "description":"Enabled permissions. If a permission isn't specified, the permission is disabled."
                }
            ]
        }
    },
    "required":[
        "accountGuid",
        "accountType"
    ]
}

Nested Schema : accountType

Match All

User or ApplicationRole.

Show Source

string

Allowed Values: [ "User", "ApplicationRole" ]
User or ApplicationRole.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AccountType"
        },
        {
            "description":"User or ApplicationRole."
        }
    ]
}

Nested Schema : permissions

Match All

Enabled permissions. If a permission isn't specified, the permission is disabled.

Show Source

object Permissions
Enabled permissions. If a permission isn't specified, the permission is disabled.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Permissions"
        },
        {
            "description":"Enabled permissions. If a permission isn't specified, the permission is disabled."
        }
    ]
}

Nested Schema : Permissions

Type: object

Show Source

changePermission: boolean
delete: boolean
execute: boolean
list: boolean
read: boolean
takeOwnership: boolean
write: boolean

{
    "type":"object",
    "properties":{
        "read":{
            "type":"boolean"
        },
        "write":{
            "type":"boolean"
        },
        "execute":{
            "type":"boolean"
        },
        "list":{
            "type":"boolean"
        },
        "delete":{
            "type":"boolean"
        },
        "changePermission":{
            "type":"boolean"
        },
        "takeOwnership":{
            "type":"boolean"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Examples

This example shows you how to obtain the access control list (ACL) for a specific catalog object, MySalesWorkbook. The object type value is workbooks. The object ID of the workbook is /@Catalog/shared/Sales/MySalesWorkbook which has the Base64URL-safe encoded id value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s

cURL Example:

First, obtain the object ID of the workbook you want ACL details for. Base64URL-safe encode the value to determine the id. You can obtain the Object ID value from the Inspect dialog for the object in Oracle Analytics Server.

Run the cURL command with the required type and id:

curl -i \
     --header 'Authorization: Bearer <token>' \ 
     --header 'Content-Length: 0' \
     --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s=/actions/getACL'

Example of Request Body

Not applicable.

Example of Response Body

Status 200:

[
 {
   "accountGuid": "BIConsumer",
   "accountType": "ApplicationRole",
   "accountDisplayName": "BI Consumer",
      "permissions": {
          "read": true,
          "write": false,
          "list": true,
          "delete": false,
          "changePermission": false,
          "takeOwnership": false
       }
 },
 {
  "accountGuid": "BIServiceAdministrator",
  "accountType": "ApplicationRole",
  "accountDisplayName": "BI Service Administrator",
      "permissions": {
         "read": true,
         "write": true,
         "list": true,
         "delete": true,
         "changePermission": true,
         "takeOwnership": true
       }
 }
]