Oracle Analytics CloudのためのREST API

分析詳細の取得

get

/api/20210901/catalog/analysis/{urlBase64AnalysisId}

指定されたIDの既存の分析の詳細を返します。たとえば、所有者、名前、説明、ID、最終変更日、オブジェクト・タイプ、親IDなどの詳細です。 'content'が問合せパラメータ'fields'を介してリクエストされた場合、分析'content'も返されます。

リクエスト

パス・パラメータ

urlBase64AnalysisId(required): string

Base64URLエンコーディングの分析ID。たとえば、IDが/myuser/samplefolder/samplesales',の分析がある場合、Base64URLでエンコードされた値'L215dXNlci9zYW1wbGVmb2xkZXIvc2FtcGxlc2FsZXM='を入力します。

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作。

ルート・スキーマ: schema

Type: object

400レスポンス

分析でエンコードされたIDが無効です

ルート・スキーマ: 400BadRequest

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

403レスポンス

分析を表示する権限がありません

ルート・スキーマ: 403Forbidden

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

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

先頭に戻る

例

これらの例は、特定のIDを持つ分析の詳細を返す方法を示しています。

例1 - フィールド基準なし
例2 - 複数のフィールド基準

例1 - フィールド基準なし

この例では、返すフィールドを指定せずに、指定されたIDを持つ既存の分析の詳細を返します。フィールドを一覧表示すると、content以外のすべての詳細が返されます。分析のオブジェクトIDは、Base64URLでエンコードされたID値を持つ'/shared/Sales/Sales Analysis'です: L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw。「タイプ別のカタログ項目の取得」を使用して、分析のIDを取得できます。

cURLの例:

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

リクエスト本文の例

Not applicable.

レスポンス本文の例

{   
    "owner": "smith",    
    "name": "/shared/Sales/Sales Analysis",
    "description": "Sales Analysis",
    "id": "L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw",
    "last modified": "2025-01-01T19:53:07Z",
    "type": "analyses",
    "parent": "L3NoYXJlZC9TYWxlcy8",
}

例2 - 複数のフィールド基準

この例では、指定されたIDを持つ既存の分析の詳細を返します。返される詳細は、?fields=の後にリストされたフィールド(この場合は分析名、説明およびコンテンツ詳細)によって決まります。分析のオブジェクトIDは、Base64URLでエンコードされたID値を持つ'/shared/Sales/Sales Analysis'です: L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw。

cURLの例:

curl    --header 'Authorization: Bearer <token>'    \
         --request GET 'https://<hostname>/api/20210901/catalog/analysis/L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw?fields=name,description,content'

リクエスト本文の例

Not applicable.

レスポンス本文の例

{
    "name": "shared/Sales/Sales Analysis",
    "description": "Sales Analysis",    
    "content": "<analysis-xml-string>"
}

先頭に戻る