移動先

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

データベースの名前変更

post

/essbase/rest/v1/applications/{applicationName}/databases/actions/rename

データベースの名前を変更します。コピー元のアプリケーション名、およびコピー元とコピー先のデータベース名を指定する必要があります。コピー先のアプリケーション名は必要ありません。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• applicationName(required): string

  コピー元アプリケーション名。

本体()

コピー元およびコピー先のデータベース情報。

ルート・スキーマ : CopyRenameBean

型: object

ソースの表示

• from(required): string
• to(required): string

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

データベースの名前が正常に変更されました。

400 レスポンス

不正なリクエスト

データベースの名前変更に失敗しました。

500 レスポンス

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

先頭に戻る

例

次の例は、Essbase REST APIを使用してデータベース(キューブ)の名前を変更する方法を示します。

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

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

ソース・アプリケーション名をパス・パラメータとして、ソース・キューブ名と宛先キューブ名を本体に指定します。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/MyApp/databases/actions/rename -H "Accept: application/json" -H "Content-Type: application/json" -d '{"from": "Basic", "to": "MyBasic"}' -u %User%:%Password%

レスポンスの例

エラーが発生した場合は、次のようなレスポンスが返されます。

{
  "errorMessage" : "Database \"Basic\" does not exist.",
  "errorCode" : 1051032
}

先頭に戻る