Oracle Essbase REST API

ファイルのアップロードまたはフォルダの作成

put

/essbase/rest/v1/files/{path}

Essbaseにファイルをアップロードします。

サポートされているファイル・タイプとしては、テキスト・ファイル、ルール・ファイル、計算スクリプト・ファイルおよびMaxLスクリプト・ファイルがあります。

コンテンツ・タイプがなくURLでフォルダ名が指定されている場合は、フォルダが作成されます。

リクエスト

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

application/octet-stream

パス・パラメータ

path(required): string

パターン: .+

カタログ・パス。Content-Type=application/octet-streamの場合、これはファイル名となります。それ以外の場合はフォルダ名となります。

問合せパラメータ

overwrite(required): boolean

ファイルの追加の場合のみ適用できます。フォルダの上書きはサポートされていません。

デフォルト値: false

ヘッダー・パラメータ

append: boolean

既存のファイルに付加するかどうか。

デフォルト値: false

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

ファイルが正常にアップロードされました(Content-Typeがapplication/octet-streamである場合)。または、フォルダが正常に作成されました(Content-Typeがない場合)。

ルート・スキーマ : GenericEntity

型: object

ソースの表示

entity: object entity
type: object Type

{
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/definitions/Type"
        },
        "entity":{
            "type":"object"
        }
    }
}

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

型: object

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

型: object

ソースの表示

typeName: string

{
    "type":"object",
    "properties":{
        "typeName":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

ログインしているユーザーに適切な権限がないか、そのファイルまたはフォルダがすでに存在する可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、1) Essbaseキューブ・ディレクトリにファイルをアップロードする方法と、2)共有ディレクトリにファイルをアップロードする方法を示します。

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

cURLコマンド1

この例では、Data_Basic.txtをSample Basicキューブ・ディレクトリにアップロードします。ファイルがすでに存在する場合は、overwrite=trueが問合せパラメータとして渡されるため、このAPIによってファイルが上書きされます。

call properties.bat
curl -X PUT "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Data_Basic.txt?overwrite=true" -H "accept: application/json"

レスポンス本体1

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

[
  {
    "rel": "download",
    "href": "https://192.0.2.1:443/essbase/rest/v1/files/applications/Sample/Basic/Data_Basic.txt",
    "method": "GET",
    "type": "application/octet-stream"
  }
]

cURLコマンド2

この例では、datafile.txtをEssbaseファイル・カタログの共有ディレクトリにアップロードします。

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/files/shared/datafile.txt" -H "Accept:application/json" -H "Content-Type:application/octet-stream" --data-binary @datafile.txt -u %User%:%Password%

レスポンス本体2

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

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

先頭に戻る