アプリケーション構成の更新

put

/essbase/rest/v1/applications/{applicationName}/configurations

アプリケーション構成を更新し、更新後の構成詳細を返します。

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
本体()

構成プロパティ値のエントリ。

ルート・スキーマ : schema
型: array
ソースの表示
ネストされたスキーマ : ApplicationConfigEntry
型: object
ソースの表示
  • trueの場合、構成プロパティは有効になります。

    falseの場合、構成プロパティは無効になります。

  • 構成プロパティの説明。

  • 構成プロパティの使用例。例: DATACACHESIZE 90M

  • 構成プロパティ結果を絞り込むためのフィルタ・キー。たとえば、key=A*の場合、文字Aで始まるすべての構成プロパティが返されます。デフォルトは*です

  • links
  • 構成プロパティの構文。例: DATACACHESIZE n

  • 構成プロパティの値。例: 1024

先頭に戻る

レスポンス

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

200 レスポンス

OK

構成が正常に更新されました。構成の詳細、および構成を取得、編集または削除するためのリンクを返します。

本体()
ルート・スキーマ : ApplicationConfigList
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : ApplicationConfigEntry
型: object
ソースの表示
  • trueの場合、構成プロパティは有効になります。

    falseの場合、構成プロパティは無効になります。

  • 構成プロパティの説明。

  • 構成プロパティの使用例。例: DATACACHESIZE 90M

  • 構成プロパティ結果を絞り込むためのフィルタ・キー。たとえば、key=A*の場合、文字Aで始まるすべての構成プロパティが返されます。デフォルトは*です

  • links
  • 構成プロパティの構文。例: DATACACHESIZE n

  • 構成プロパティの値。例: 1024

400 レスポンス

不正なリクエスト

構成の更新に失敗しました。アプリケーション名または構成エントリが無効か、指定した構成プロパティがアプリケーションに追加されていません。

415 レスポンス

受入れできません

メディア・タイプがサポートされていないか指定されていません。

500 レスポンス

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

先頭に戻る

次の例では、指定されたEssbaseアプリケーションに対して現在設定されている構成を更新する方法を示します。配列を使用して、複数の構成プロパティを一度に更新できます。

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

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

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/configurations?links=none" -H "Accept:application/json" -H "Content-Type:application/json" --data "@./updateconfigs.json" -u %User%:%Password%

入力JSONデータ

Sample_Dynamic Basicに基づく前述のスクリプトでは、updateconfigs.jsonに指定されたアプリケーション構成配列が実行されます。入力ファイルの内容は次のとおりです。

[
  {
    "key" : "HYBRIDBSOINCALCSCRIPT",
    "value" : "NONE",
    "configured" : true
  }, {
    "key" : "ASODYNAMICAGGINBSO",
    "value" : "FULL",
    "configured" : true
  } 
]

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

[ {
  "key" : "HYBRIDBSOINCALCSCRIPT",
  "value" : "NONE",
  "configured" : false
}, {
  "key" : "ASODYNAMICAGGINBSO",
  "value" : "FULL",
  "configured" : false
} ]
先頭に戻る