Oracle Essbase REST API

レポート・スクリプトの実行

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/executeReport

レポート・スクリプト仕様ファイルの実行によって生成された出力を返します。

リクエスト

パス・パラメータ

applicationName(required): string

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

データベース名。

問合せパラメータ

filename(required): string

レポート・スクリプト・ファイル名。
lockForUpdate: string

そのレポート仕様でアクセスされるすべてのブロックがロックされます。

デフォルト値: false

先頭に戻る

レスポンス

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

application/octet-stream

200 レスポンス

レポートが正常に生成されました。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseキューブ・ディレクトリにアーティファクトとして保存されたレポート・スクリプトの結果を取得する方法を示します。

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

この例では、SampleアプリケーションおよびBasicキューブに関連付けられているレポート・スクリプトorderbyがあるとします。スクリプトの内容は次のとおりです:

//Sample 18: Ordering Data Values  // cube: sample.basic // script: orderby.rep<Page
          ("Measures")<Column
          ("Scenario",
          "Year")<Row
          ("Market",
          "Product")"Sales""Scenario""Jan" "Feb" "Mar" "Apr""New York" "Product" "100" "100-10" "100-20" "100-30" "200" "200-10""200-20" "200-30" "200-40" "300" "300-10" "300-20" "300-30" "400""400-10" "400-20" "400-30" "Diet" "100-20" "200-20" "300-30"<ORDERBY
          ("Product",
          @DATACOLUMN(1)
          ASC,
          @DATACOLUMN(2)
          DESC,
          @DATACOLUMN(3)
          ASC
          @DATACOLUMN
          (4) DESC)     !

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

次のWindowsスクリプトは、レポート・スクリプトを実行し、その出力をファイルに書き込みます。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/executeReport?filename=orderby&lockForUpdate=false" -H "Accept:application/octet-stream" -o orderby_out.txt -u %User%:%Password%

レスポンス本体の例

成功すると、次のレポート出力がorderby_out.txtに書き込まれます。

                                             Sales Scenario 

                                       Jan      Feb      Mar      Apr 
                                  ======== ======== ======== ======== 

New York         100-20           #Missing #Missing #Missing #Missing 
                 100-30           #Missing #Missing #Missing #Missing 
                 200-20           #Missing #Missing #Missing #Missing 
                 200-30           #Missing #Missing #Missing #Missing 
                 300-30           #Missing #Missing #Missing #Missing 
                   Diet           #Missing #Missing #Missing #Missing 
                 200-10                 61       61       63       66 
                 400-30                134      189      198      198 
                 300-20                180      180      182      189 
                 400-20                219      243      213      223 
                 400-10                234      232      234      245 
                 300-10                483      495      513      638 
                 200-40                490      580      523      564 
                   200                 551      641      586      630 
                   400                 587      664      645      666 
                   300                 663      675      695      827 
                 100-10                678      645      675      712 
                   100                 678      645      675      712 
                     Product         2,479    2,625    2,601    2,835

何か問題がある場合は、エラーが返されます。次に例を示します。

{
  "errorMessage" : "NULL argument (5) passed to ESSAPI function EssReportFile",
  "errorCode" : 1030008
}

先頭に戻る