Oracle Essbase REST API

ドリル・スルー・レポートの実行

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}

指定されたアプリケーションおよびデータベース内のドリル・スルー・レポートを実行し、レコードを返します。

リクエスト

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

application/json

パス・パラメータ

applicationName(required): string

アプリケーション名。
databaseName(required): string

データベース名。
name(required): string

ドリル・スルー・レポート名。

ドリル・スルー・メタデータ。例のリクエスト本体では、dtrContextがSmart Viewのセルの交差に対応しています。

ルート・スキーマ : DrillthroughMetadataBean

型: object

ソースの表示

aliasTable: string

オプション。ドリル・スルー・レポートで使用するメンバー別名を示す別名表。指定しない場合、デフォルトのEssbase別名表が使用されます。
dtrContext: array dtrContext

Smart Viewのセルの交差。
sessionId: string

{
    "type":"object",
    "properties":{
        "dtrContext":{
            "type":"array",
            "description":"<p>The intersection of cells in Smart View.</p>",
            "items":{
                "$ref":"#/definitions/DrillThroughRange"
            }
        },
        "aliasTable":{
            "type":"string",
            "description":"<p>Optional. Alias table specifying member aliases to use in the drill through report. If unspecified, the default Essbase alias table is used.</p>"
        },
        "sessionId":{
            "type":"string"
        }
    }
}

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

型: array

Smart Viewのセルの交差。

ソースの表示

配列: object DrillThroughRange

{
    "type":"array",
    "description":"<p>The intersection of cells in Smart View.</p>",
    "items":{
        "$ref":"#/definitions/DrillThroughRange"
    }
}

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

型: object

ソースの表示

cells: object cells

使用可能なその他のプロパティ: additionalProperties

{
    "type":"object",
    "properties":{
        "cells":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "uniqueItems":true,
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースの表示

array additionalProperties

一意のアイテムが必要: true

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "uniqueItems":true,
        "items":{
            "type":"string"
        }
    }
}

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

型: array

一意のアイテムが必要: true

ソースの表示

配列: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

application/json

200 レスポンス

ドリルスルー・レポートは正常に実行されました。結果はJSON配列で、最初のノードが各列のデータ型、2番目のノードが列名、残りのノードがレポート内の各レコードに対応するデータ・ノードを示します。

400 レスポンス

不正なリクエスト

ドリルスルー・レポートの実行に失敗しました。

415 レスポンス

受入れできません

メディア・タイプがサポートされていないか指定されていません。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、ドリル・スルー・レポート定義を実行する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr" -H Accept:application/json -H Content-Type:application/json --data "@./dtrcontext.json" -u %User%:%Password%

サンプルのJSONペイロード

前述のcURLの例では、次のJSONペイロードがdtrcontext.jsonで配信されます。

{
 "aliasTable":"default",
 "dtrContext":[
   {
     "cells":{
       "Year":["Jan"],
       "Product":["Cola"],
       "Measures":["Sales"],
       "Market":["New York"],
       "Scenario":["Scenario"]}
   }, {
     "cells":{
       "Year":["Aug"],
       "Product":["Cola"],
       "Measures":["Sales"],
       "Market":["New York"],
       "Scenario":["Scenario"]}
   }
  ]
}

レスポンス本体の例

次の例は、レスポンス本体の内容を示しています。結果はJSON配列で、最初のノードが各列のデータ型、2番目のノードが列名、残りのノードがレポート内の各レコードに対応するデータ・ノードを示します。この出力例は長いため、切り捨てられています。

[ [ "STRING", "STRING", "STRING", "STRING", "STRING" ], 
[ "PRODUCT", "MONTH", "CITY", "SALES", "COGS" ], 
[ "100-10", "Aug", "New York", "910", "364" ], 
[ "100-10", "Aug", "New York", "860", "340" ], 
[ "100-10", "Aug", "New York", "910", "364" ], 
[ "100-10", "Aug", "New York", "860", "340" ], 
...
]

先頭に戻る