Oracle Essbase REST API

ジョブを使用したZipファイルの抽出

post

/essbase/rest/v1/files/actions/extractJob

システム・ジョブを使用して、現在のEssbaseカタログのzipファイルを抽出します。アプリケーション、ユーザーおよび共有フォルダに対してサポートされています。

このエンドポイントは、「Zipファイルの展開」に似ていますが、「ジョブ・リストの取得」を使用してモニターできるシステム・ジョブが開始されます。「Zipファイルの展開」でエラーが発生した場合は、このエンドポイントを使用します。

リクエスト

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

application/json
application/xml

問合せパラメータ

overwrite: boolean

既存のファイルを上書きします。フォルダには適用できません。

デフォルト値: false

Zipファイル・パスの詳細。

ルート・スキーマ : ZipFileDetails

型: object

ソースの表示

path: string

zipファイルへのカタログ・パス。

{
    "type":"object",
    "properties":{
        "path":{
            "type":"string",
            "description":"<p>Catalog path to the zip file.</p>"
        }
    }
}

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

zipファイル・エクストラクタ・ジョブが正常に発行されました。

400 レスポンス

不正なリクエスト

zipファイル・エクストラクタ・ジョブの発行に失敗しました。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseファイル・カタログにzipファイルをアップロードし、ジョブを使用してその内容を展開する方法を示します。

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

ZipをアップロードするためのcURLコマンド

次のcURLコマンドは、Essbaseファイル・カタログのsharedディレクトリにzipファイルをアップロードします。

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/files/shared/datafiles.zip?overwrite=true" -H "accept: application/json" -H "Content-Type:application/octet-stream" --data-binary @datafiles.zip -u %User%:%Password%

Zipのアップロード後のレスポンス本体

レスポンスにはダウンロードするリンクが含まれます。

[ {
  "rel" : "download",
  "href" : "https://myserver.example.com:9001/essbase/rest/v1/files/shared/datafiles.zip",
  "method" : "GET",
  "type" : "application/octet-stream"
} ]

ジョブを使用してZipを抽出するcURLコマンド

次のcURLコマンドは、Essbaseファイル・カタログのsharedディレクトリにあるzipファイルを抽出します。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/files/actions/extractJob -H "accept:application/json" -H "Content-Type:application/json" --data-binary "@./sharedpath.json" -u %User%:%Password%

入力ペイロード・ファイルsharedpath.jsonの内容は次のとおりです。

{ 
  "path" : "/shared/datafiles.zip"
}

レスポンス本文

レスポンスは、ジョブ番号を含むメッセージです。

{
  "message" : "Job 198 is initiated to extract zip file datafiles.zip"
}

先頭に戻る