Oracle Analytics ServerのためのREST API

カタログ品目詳細の取得

get

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

指定されたタイプおよびIDのカタログ品目に関する情報を返します。たとえば、所有者、名前、説明、ID、最終変更日、オブジェクト・タイプ、親IDなどの詳細です。アイテムがフォルダやダッシュボードなどのコンテナ・アイテムである場合、検索問合せパラメータを使用してサブ・アイテムを検索できます。検索構文の詳細は、検索オプションを参照してください。

リクエスト

パス・パラメータ

id(必須): string

base64url形式のカタログ品目ID。
type(必須):

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

問合せパラメータ

excludedFields: string

レスポンスから除外するフィールドのカンマ区切りリスト。
fields: string

レスポンスに含めるフィールドのカンマ区切りリスト。
limit: integer

ページ当たりのカタログ品目数。
page: integer

ページ番号。
search: string

検索文字列
sortBy: string

基準によるソート。
sortOrder: string

ソート順。

使用可能な値: [ "ASC", "DESC" ]
type:

カタログ品目タイプ・フィルタ

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作

ヘッダー

oa-current-page:
oa-next-page:
oa-page-count:
oa-prev-page:
oa-total-items:

ルート・スキーマ: schema

1つのスキーマに一致

ソースを表示

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/CatalogItem"
        },
        {
            "$ref":"#/components/schemas/CatalogFolderItem"
        },
        {
            "$ref":"#/components/schemas/CatalogItems"
        }
    ]
}

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

すべてに一致

ソースを表示

object CatalogItemIdRef
object CatalogItemParentIdNameRef
object Discriminator: type

Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CatalogItemIdRef"
        },
        {
            "$ref":"#/components/schemas/CatalogItemParentIdNameRef"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"Catalog item description, if any"
                },
                "type":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Types"
                        },
                        {
                            "description":"Catalog item type"
                        },
                        {
                        }
                    ]
                },
                "owner":{
                    "type":"string",
                    "description":"Catalog item owner"
                },
                "lastModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Catalog item last modified date and time"
                }
            },
            "discriminator":{
                "propertyName":"type"
            }
        }
    ]
}

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

すべてに一致

ソースを表示

allOf CatalogItem
object CatalogFolderItem-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CatalogItem"
        },
        {
            "type":"object",
            "properties":{
                "childItems":{
                    "$ref":"#/components/schemas/CatalogItems"
                }
            }
        }
    ]
}

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

Type: array

ソースを表示

Array of: CatalogItem

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

ネストされたスキーマ: Discriminator: type

Type: object

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Types"
                },
                {
                    "description":"Catalog item type"
                },
                {
                }
            ]
        },
        "owner":{
            "type":"string",
            "description":"Catalog item owner"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"Catalog item last modified date and time"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

ソースを表示

description: string

カタログ品目摘要(ある場合)
lastModified: string (date-time)

カタログ品目最終変更日時
owner: string

カタログ品目所有者
type: type

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Types"
                },
                {
                    "description":"Catalog item type"
                },
                {
                }
            ]
        },
        "owner":{
            "type":"string",
            "description":"Catalog item owner"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"Catalog item last modified date and time"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

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

Type: object

ソースを表示

id: string

カタログ品目識別子

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Catalog item identifier"
        }
    }
}

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

Type: object

ソースを表示

name: string

カタログ品目名
parentId: string

カタログの親品目識別子(カタログ品目に親がある場合)

{
    "type":"object",
    "properties":{
        "parentId":{
            "type":"string",
            "description":"Catalog parent item identifier (if catalog item has a parent)"
        },
        "name":{
            "type":"string",
            "description":"Catalog item name"
        }
    }
}

ネストされたスキーマ: CatalogFolderItem-allOf[1]

Type: object

ソースを表示

childItems: array CatalogItems

{
    "type":"object",
    "properties":{
        "childItems":{
            "$ref":"#/components/schemas/CatalogItems"
        }
    }
}

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の詳細を取得する方法を示します。オブジェクトのtype値はworkbooksです。ワークブックのオブジェクトIDは/@Catalog/shared/Sales/MySalesWorkbookで、Base64URLセーフでエンコードされたid値はL0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2sです。

cURLの例- 基準を使用しない問合せの検索

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

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

curl -i --header 'Authorization: Bearer <token>' \
--request GET 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s'

cURLの例 - 基準を使用した問合せの検索

cURLコマンドに検索問合せ基準を追加して、検索の結果をさらに絞り込むことができます。この例では、john.smith@oracle.comが所有するワークブックに、名前にsalesという単語とProductという列を含む検索基準が追加されています。

curl -i --header 'Authorization: Bearer <token>' \
--request GET 'https://<hostname>/api/20210901/catalog/workbooks?search=owner:john.smith@oracle.com name:sales
      columns:Product'

cURLの例 - サブ項目の検索

検索問合せパラメータでは、サブ項目のフォルダやダッシュボードなどのコンテナ項目を検索することもできます。この例では、shared/Salesフォルダ内のすべてのサブ項目を返します。

curl -i --header 'Authorization: Bearer <token>' \
--request GET 'https://<hostname>/api/20210901/catalog/folders/c2hhcmVkL1NhbGVz?search=*'

リクエスト本文の例

Not applicable.

レスポンス本文の例

Status 200:

[
 {
    "owner": "smith",
    "name": "MySalesWorkbook",
    "description": "My cool sales analytics",
    "id": "L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "lastModified": "2024-01-01T18:59:16Z",
    "type": "workbooks",
    "parentId": "L0BDYXRhbG9nL3NoYXJlZC9TYWxlcw" 
 }
]

先頭に戻る