Oracle Analytics CloudのためのREST API

ワークブック詳細の取得

get

/api/20210901/catalog/workbooks/{urlBase64WorkbookId}

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

リクエスト

パス・パラメータ

urlBase64WorkbookId(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/MySalesWorkbook'です: L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s。ワークブックのIDを取得するには、「タイプ別のカタログ項目の取得」を使用します。

cURLの例:

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

リクエスト本文の例

Not applicable.

レスポンス本文の例

{   
    "owner": "smith",    
    "name": "/shared/Sales/MySalesWorkbook",
    "description": "Sales Workbook",
    "id": "L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "last modified": "2025-01-01T19:53:07Z",
    "type": "workbooks",
    "parent": "L3NoYXJlZC9TYWxlcy8",
}

例2 - 複数のフィールドが指定されました

この例では、指定されたIDを持つ既存のワークブックの指定した詳細を返します。返される詳細は、?fields=、この場合はworkbook, name, descriptionおよびcontentの詳細の後にリストされたフィールドによって決まります。

cURLの例:

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

リクエスト本文の例

Not applicable.

レスポンス本文の例

{   
    "id": "L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "name": "/shared/Sales/MySalesWorkbook",
    "description": "Sales Workbook",
    "content": {
        "json": { //workbook JSON object
            ....
      }
   }
}

先頭に戻る