REST API for Oracle Analytics Cloud

Get workbook share permissions

post

/api/20210901/catalog/workbooks/{id}/actions/getSharePermissions

Get share permissions for a workbook with a given ID.

Request

Path Parameters

id(required): string

Catalog item ID in base64url format.

Supported Media Types

Root Schema : schema

Type: string

Allowed Values:

[
    ""
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : WorkbookSharePermissions

Type: array

Show Source

Array of: object WorkbookSharePermission

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

Nested Schema : WorkbookSharePermission

Type: object

Show Source

accountDisplayName: string

Read Only: true

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",
            "readOnly":true,
            "description":"Display name for the user or application role, if available."
        },
        "permissions":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkbookSharePermissionFlags"
                },
                {
                    "description":"Workbook share permissions for the account. This property can be omitted when updateMode is DeleteMatchingAccounts."
                }
            ]
        }
    },
    "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

Workbook share permissions for the account. This property can be omitted when updateMode is DeleteMatchingAccounts.

Show Source

object WorkbookSharePermissionFlags
Workbook share permissions for the account. This property can be omitted when updateMode is DeleteMatchingAccounts.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkbookSharePermissionFlags"
        },
        {
            "description":"Workbook share permissions for the account. This property can be omitted when updateMode is DeleteMatchingAccounts."
        }
    ]
}

Nested Schema : WorkbookSharePermissionFlags

Type: object

Show Source

edit(required): boolean

Whether the account can edit the workbook.
view(required): boolean

Whether the account can view the workbook.

{
    "type":"object",
    "properties":{
        "view":{
            "type":"boolean",
            "description":"Whether the account can view the workbook."
        },
        "edit":{
            "type":"boolean",
            "description":"Whether the account can edit the workbook."
        }
    },
    "required":[
        "view",
        "edit"
    ]
}

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

In this example, you return the share permissions for a workbook with the object ID /shared/Sales/MySalesWorkbook. The Base64URL-safe encoded ID value for this workbook is L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s.

You can get the ID of a workbook by using Get catalog items by type.

cURL Example:

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

Example of Request Body

Not applicable.

Example of Response Body

The response returns an array that details the workbook’s share permissions. This example shows the user Jane Doe has view-only access and users with the Sales application role have both view and edit access.

[
  {
    "accountGuid": "jane.doe@example.com",
    "accountType": "User",
    "accountDisplayName": "Jane Doe",
    "permissions": {
      "view": true,
      "edit": false
    }
  },
  {
    "accountGuid": "Sales",
    "accountType": "ApplicationRole",
    "accountDisplayName": "Sales",
    "permissions": {
      "view": true,
      "edit": true
    }
  }
]