ジャンプ先

• リクエスト
• レスポンス
• 例

カタログ品目ACLの取得

post

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

指定されたIDのカタログ品目のアクセス制御リスト(ACL)を取得します。

リクエスト

パス・パラメータ

• id(必須): string
  base64url形式のカタログ品目ID。
• type(必須):
  カタログ品目のタイプこのAPIがサポートするコンテンツ・タイプには、フォルダ、ワークブック、サブジェクト領域、分析、ダッシュボード、ダッシュボード・ページ、レポート、接続、データセット、データ・フロー、シーケンス、スクリプトおよびセマンティック・モデルが含まれます。

サポートされているメディア・タイプ

• */*

リクエスト本文 - */* ()

ルート・スキーマ: schema

Type: string

指定できる値: [ "" ]

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功した操作

本文()

ルート・スキーマ: CatalogItemACLs

Type: array

ソースを表示

• Array of: object CatalogItemACL

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

ネストされたスキーマ: CatalogItemACL

Type: object

ソースを表示

• accountDisplayName: string
  ユーザーまたはアプリケーション・ロールの表示名(使用可能な場合)。
• accountGuid(必須): string
  ユーザーIDまたはアプリケーション・ロール名。
• accountType(必須): accountType
• 権限: 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"
    ]
}

ネストされたスキーマ: accountType

すべてに一致

UserまたはApplicationRole。

ソースを表示

• string
  指定できる値: [ "User", "ApplicationRole" ]
• UserまたはApplicationRole。

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

ネストされたスキーマ: permissions

すべてに一致

有効な権限。権限が指定されていない場合、権限は無効になります。

ソースを表示

• object Permissions
• 有効な権限。権限が指定されていない場合、権限は無効になります。

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

ネストされたスキーマ: Permissions

Type: object

ソースを表示

• 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レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

未承認(資格情報の欠落や期限切れなど)。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

見つかりません。リクエストされたリソースが見つかりませんでした。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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"
    ]
}

先頭に戻る

例

この例では、特定のカタログ・オブジェクトMySalesWorkbookのアクセス制御リスト(ACL)を取得する方法を示します。オブジェクトのtype値はworkbooksです。ワークブックのオブジェクトIDは/@Catalog/shared/Sales/MySalesWorkbookで、Base64URLセーフでエンコードされたid値はL0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2sです。

cURLの例:

まず、ACLの詳細が必要なワークブックのオブジェクトIDを取得します。Base64URLセーフで値をエンコードしてidを決定します。「オブジェクトID」の値は、Oracle Analytics Serverのオブジェクトの「検査」ダイアログから取得できます。

必要なtypeおよびidを指定してcURLコマンドを実行します。

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

リクエスト本文の例

Not applicable.

レスポンス本文の例

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
       }
 }
]

先頭に戻る