カタログ品目詳細の取得
/api/20210901/catalog/{type}/{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レスポンス
- object CatalogItemIdRef
- object CatalogItemParentIdNameRef
- object Discriminator: type
Discriminator:
{ "propertyName":"type" }
object
-
description: string
カタログ品目摘要(ある場合)
-
lastModified: string (date-time)
カタログ品目最終変更日時
-
owner: string
カタログ品目所有者
-
type: type
object
-
name: string
カタログ品目名
-
parentId: string
カタログの親品目識別子(カタログ品目に親がある場合)
400レスポンス
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
401レスポンス
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
403レスポンス
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
404レスポンス
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
500レスポンス
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
例
この例では、特定のカタログ・オブジェクト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" } ]