カタログ品目詳細の取得

get

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

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

リクエスト

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

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

先頭に戻る

レスポンス

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

200レスポンス

成功した操作
ヘッダー
本文()
ルート・スキーマ: schema
1つのスキーマに一致
ソースを表示
ネストされたスキーマ: CatalogItem
すべてに一致
ソースを表示
ネストされたスキーマ: CatalogFolderItem
すべてに一致
ソースを表示
ネストされたスキーマ: CatalogItems
Type: array
ソースを表示
ネストされたスキーマ: Discriminator: type
Type: object
ソースを表示
ネストされたスキーマ: CatalogItemIdRef
Type: object
ソースを表示
ネストされたスキーマ: CatalogItemParentIdNameRef
Type: object
ソースを表示
ネストされたスキーマ: CatalogFolderItem-allOf[1]
Type: object
ソースを表示

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

401レスポンス

未承認(資格情報の欠落や期限切れなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

404レスポンス

見つかりません。リクエストされたリソースが見つかりませんでした。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示
先頭に戻る

この例では、特定のカタログ・オブジェクト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" 
 }
]
先頭に戻る