移動先

• リクエスト
• レスポンス
• 例

ファイルの移動または名前変更

post

/essbase/rest/v1/files/actions/move

ソースから宛先にファイルを移動するか、ファイルまたはフォルダの名前を変更します。フォルダの移動はサポートされていません。フォルダの名前変更は、そのフォルダがアプリケーション・ディレクトリにない場合のみサポートされます。

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• overwrite: boolean

  既存のファイルを上書きします。ファイルの移動または名前変更にのみ適用できます。

  デフォルト値: false

本体()

ファイル・パスの詳細。

ルート・スキーマ : FilePathDetail

型: object

ソースの表示

• from: string
• to: string

{
    "type":"object",
    "properties":{
        "to":{
            "type":"string"
        },
        "from":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ファイル操作が正常に完了しました。

400 レスポンス

不正なリクエスト

ログインしているユーザーに、適切な権限がない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseファイル・カタログのソース・パスから宛先パスにファイルを移動する方法を示します。このエンドポイントを使用して、ファイルの名前を変更することもできます。

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

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

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/files/actions/move?overwrite=true" -H "Accept: application/json" -H "Content-Type:application/json" -d '{"from": "/users/ksmith/sample.zip" , "to": "/shared/sample_shared.zip"}' -u %User%:%Password%

レスポンス本体の例

レスポンスが返されるのは、エラーがある場合のみです。

{
  "errorMessage" : "Specified path '/users/ksmith/sample.zip' does not exist"
}

先頭に戻る