Oracle Analytics ServerのためのREST API

タイプ別のカタログ品目の取得

get

/api/20210901/catalog/{type}

指定されたタイプのカタログ品目を返します。たとえば、フォルダ、ワークブック、サブジェクト領域、分析、ダッシュボード、ダッシュボード・ページ、レポート、接続、データセット、データ・フロー、シーケンス、スクリプトまたはセマンティック・モデルのリストを返します。APIからの出力がページングされます。ページの詳細は、結果ヘッダー(oa-current-page、oa-page-count、oa-next-page)で入手できます。oa-next-pageヘッダーは、次のページがない場合は返されません。

リクエスト

パス・パラメータ

type(必須):

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

問合せパラメータ

excludedFields: string

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

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

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

ページ番号。
search: string

検索文字列
sortBy: string

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

ソート順。

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作

ヘッダー

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

ルート・スキーマ: schema

1つのスキーマに一致

ソースを表示

array CatalogItems
array TypeInfos

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

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

Type: array

ソースを表示

Array of: CatalogItem

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

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

Type: array

ソースを表示

Array of: object TypeInfo

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

ネストされたスキーマ: 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"
            }
        }
    ]
}

ネストされたスキーマ: 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"
        }
    }
}

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

Type: object

ソースを表示

type: string

指定できる値: [ "workbooks", "folders", "datasets", "connections", "dataflows", "models", "sequences", "subjectAreas", "analysis", "reports", "dashboards", "dashboardpages", "scripts" ]

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

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

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

先頭に戻る

例

これらの例は、異なる検索基準を持つ特定のtypeのすべてのカタログ品目を返す方法を示しています。

例1 - ワイルドカード検索を使用したワークブックの返却
例2 - 特定の検索基準を使用したワークブックの返却
例3 - タイプ別のアイテムのリストの返却

例1 - ワイルドカード検索を使用したワークブックの返却

この例では、カタログ内のすべてのワークブックのリストを返します。

cURLの例:

ワイルドカード検索を指定してcURLコマンドを実行します(search=*)。

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

リクエスト本文の例

Not applicable.

レスポンス・ヘッダーの例

APIからのレスポンスはページングされ、ページの詳細が結果ヘッダー(oa-current-page、oa-page-count、oa-next-page)で確認できます。

次のページがない場合、oa-next-pageヘッダーは返されません。

レスポンス本文の例

Status 200:

[
 {
    "owner": "smith",
    "name": "Sales Workbook",
    "description": "Sales forecast 2024",
    "id": "L3NoYXJlZC9TYWxlcy9TYWxlcyBXb3JrYm9vaw==",
    "lastModified": "2024-01-01T18:59:16Z",
    "type": "workbooks",
    "parentId": "L3NoYXJlZC9TYWxlcw==" 
 }
 {
    "owner": "jones",
    "name": "Product Analysis",
    "description": "Compare UK product sales",
    "id": "L3NoYXJlZC9Qcm9kdWN0cy9Qcm9kdWN0IEFuYWx5c2lz",
    "lastModified": "2024-01-01T18:59:16Z",
    "type": "workbooks",
    "parentId": "L3NoYXJlZC9Qcm9kdWN0cw==" 
 }
 {
   ...
 }
]

id値は、Base64URLエンコーディングを使用したカタログ・オブジェクトへのフルパスです。このid値をtypeとともに使用して、カタログ・オブジェクトの詳細を取得できます。カタログ品目詳細の取得を参照してください。

例2 - 特定の検索基準を使用したワークブックの返却

この例では、名前に2024を含むワークブックのリストを返します。

cURLの例:

検索文字列2024を指定してcURLコマンドを実行します(つまり、search=2024)。

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

リクエスト本文の例

Not applicable.

レスポンス本文の例

Status 200:

[
 {
    "owner": "smith",
    "name": "Sales Workbook",
    "description": "Sales forecast 2024",
    "id": "L3NoYXJlZC9TYWxlcy9TYWxlcyBXb3JrYm9vaw==",
    "lastModified": "2024-01-01T18:59:16Z",
    "type": "workbooks",
    "parentId": "L3NoYXJlZC9TYWxlcw==" 
 }
]

例3 - タイプ別のアイテムのリストの返却

カタログAPIでは、様々なアイテム・タイプ(フォルダ、データセット、接続、データ・フロー、モデル、シーケンス、サブジェクト領域、分析およびワークブック)がサポートされています。

これらの例は、各タイプのアイテムのリストを返すのに必要な構文を示しています。

cURLの例:

検索ワイルドカード(*)または特定の検索基準を指定してcURLコマンドを実行します。

curl -i --header 'Authorization: Bearer <token>' /
--request GET 'https://<hostname>/api/20210901/catalog/<itemtype>?search=<criteria>'

<itemtype>を使用して、返すアイテムのタイプを指定します。

フォルダ: https://<hostname>/api/20210901/catalog/folders?search=*
接続: https://<hostname>/api/20210901/catalog/connections?search=*
データセット: https://<hostname>/api/20210901/catalog/datasets?search=*
データ・フロー: https://<hostname>/api/20210901/catalog/dataflows?search=*
シーケンス: https://<hostname>/api/20210901/catalog/sequences?search=*
セマンティック・モデル: https://<hostname>/api/20210901/catalog/models?search=*
サブジェクト領域: https://<hostname>/api/20210901/catalog/subjectAreas?search=*
分析: https://<hostname>/api/20210901/catalog/analysis?search=*
ワークブック: https://<hostname>/api/20210901/catalog/workbooks?search=*

リクエスト本文の例

APIからのレスポンスはページングされ、ページの詳細が結果ヘッダー(oa-current-page、oa-page-count、oa-next-page)で確認できます。

レスポンス本文の例

Status 200:
[
 {
    "owner": "admin",
    "name": "Sales",
    "description": "Folder for sales workbooks",
    "id": "L3NoYXJlZC9TYWxlcw==",
    "lastModified": "2024-01-01T18:59:16Z",
    "type": "folders",
    "parentId": " L3NoYXJlZA==" 
 }
 {
   ...
 }
]

先頭に戻る