機械翻訳について
  1. Oracle Analytics CloudのためのREST API
  2. タスク
  3. カタログ

カタログ品目の取得

get

/api/20210901/catalog

検索基準がない場合は、サポートされているカタログ項目タイプのリストを返します。 検索条件を指定すると、指定した条件に一致するカタログ・アイテムが返されます。 返されたリストの最大項目数は10000です。 検索構文の詳細は、「検索オプション」を参照してください。

リクエスト

問合せパラメータ
  • レスポンスから除外するフィールドのカンマ区切りリスト。
  • レスポンスに含めるフィールドのカンマ区切りリスト。
  • ページ当たりのカタログ品目数。
  • trueの場合、検索はコンテンツ管理モードで実行されます。 コンテンツ管理モードを有効にするには、「コンテンツの管理」権限が必要です。
  • ページ番号。
  • 検索文字列
  • 基準によるソート。
  • ソート順。
    使用可能な値: [ "ASC", "DESC" ]
  • カタログ品目タイプ・フィルタ。 これらのコンテンツ・フィルタ・タイプがサポートされています
    • フォルダ - カタログ・オブジェクトを含むフォルダ。
    • ワークブック - Workbooks.
    • subjectAreas - サブジェクト領域。
    • データセット - Datasets.
    • 接続 - 接続詳細を含むオブジェクト。
    • データ・フロー - データ・フロー。
    • モデル - 予測モデルと機械学習モデル。
    • シーケンス - Sequences.
    • 分析 - Analyses.
    • レポート - ピクセルパーフェクト・レポート(BIPレポート)。
    • ダッシュボード - Dashboards.
    • ダッシュボード・ページ - ダッシュボード・ページ。
    • dashboardgroupfolders - ホーム・ページのナビゲーション・メニューから使用できるワークブックおよびダッシュボード。
    • スクリプト - 機械学習およびデータ・キュレーション用のカスタム・スクリプト。

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

先頭に戻る

レスポンス

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

200レスポンス

成功した操作
ヘッダー
本文()
ルート・スキーマ: schema
1つのスキーマに一致
ソースを表示
ネストされたスキーマ: CatalogItems
Type: array
ソースを表示
ネストされたスキーマ: TypeInfos
Type: array
ソースを表示
ネストされたスキーマ: CatalogItem
すべてに一致
ソースを表示
ネストされたスキーマ: Discriminator: type
Type: object
ソースを表示
ネストされたスキーマ: CatalogItemIdRef
Type: object
ソースを表示
ネストされたスキーマ: CatalogItemParentIdNameRef
Type: object
ソースを表示
ネストされたスキーマ: TypeInfo
Type: object
ソースを表示
  • 許容値: [ "workbooks", "folders", "datasets", "connections", "dataflows", "models", "sequences", "subjectAreas", "analysis", "reports", "dashboards", "dashboardpages", "dashboardgroupfolders", "scripts" ]

400レスポンス

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

401レスポンス

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

500レスポンス

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

例

この例では、カタログREST APIがサポートするカタログ・オブジェクトのタイプのリストを取得する方法を示します。

cURL例 - 検索基準なし

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

リクエスト本文の例

Not applicable.

レスポンス本文の例

Status 200:
[
    {"type": "workbooks"},
    {"type": "folders"},
    {"type": "datasets"},
    {"type": "connections"},
    {"type": "dataflows"},
    {"type": "models"},
    {"type": "sequences"},
    {"type": "subjectAreas"},
    {"type": "analysis"},
    {"type": "reports"},
    {"type": "dashboardgroupfolders"},
    {"type": "dashboardfolders"},
    {"type": "dashboardpages"},
    {"type": "dashboards"},
    {"type": "scripts"}]

cURL例 - 検索基準あり

cURLコマンドの検索パラメータに検索問合せ基準を追加して、検索の結果をさらに絞り込むことができます。 この例では、名前にsalesという単語を含むjohn.smith@oracle.comが所有するワークブック、および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=*'

cURL例 - manageContentを有効にした場合

適切な権限がある場合は、manageContentパラメータをtrueに設定して、検索問合せをコンテンツ管理モードで実行できます。 コンテンツ管理モードで検索すると、APIは自分が所有または共有していないアイテムを返すことができます。 コンテンツ管理モードで問合せを実行するには、「コンテンツの管理」権限またはBIサービス管理者ロールが必要です。

この例では、すべてのユーザーが所有するすべてのカタログ・オブジェクトのリストを返します:

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

この例では、すべてのユーザーが所有するすべてのワークブックのリストを返します:

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

この例では、会社を去ったユーザー(john.smith@example.com)が所有するすべてのフォルダのリストを返します:

curl -i --header 'Authorization: Bearer <token>' \
  --request GET 'https://<hostname>/api/20210901/catalog/folders?manageContent=true&search=owner: john.smith@example.com'
先頭に戻る