アプリケーション構成の更新
/essbase/rest/v1/applications/{applicationName}/configurations/{configId}
アプリケーション構成を更新し、更新後の構成詳細を返します。
リクエスト
- application/json
- application/xml
- applicationName(required): string
アプリケーション名。
- configId(required): string
構成プロパティ名。
構成プロパティ値のエントリ。
object- configured: boolean
trueの場合、構成プロパティは有効になります。
falseの場合、構成プロパティは無効になります。
- description: string
構成プロパティの説明。
- example: string
構成プロパティの使用例。例:
DATACACHESIZE 90M - key: string
構成プロパティ結果を絞り込むためのフィルタ・キー。たとえば、
key=A*の場合、文字Aで始まるすべての構成プロパティが返されます。デフォルトは*です - links: array links
- syntax: string
構成プロパティの構文。例:
DATACACHESIZE n - value: string
構成プロパティの値。例:
1024
レスポンス
- application/json
- application/xml
200 レスポンス
OK
構成は正常に更新されました。構成の詳細、および構成を取得、編集または削除するためのリンクを返します。
object- configured: boolean
trueの場合、構成プロパティは有効になります。
falseの場合、構成プロパティは無効になります。
- description: string
構成プロパティの説明。
- example: string
構成プロパティの使用例。例:
DATACACHESIZE 90M - key: string
構成プロパティ結果を絞り込むためのフィルタ・キー。たとえば、
key=A*の場合、文字Aで始まるすべての構成プロパティが返されます。デフォルトは*です - links: array links
- syntax: string
構成プロパティの構文。例:
DATACACHESIZE n - value: string
構成プロパティの値。例:
1024
400 レスポンス
不正なリクエスト
構成の更新に失敗しました。アプリケーション名または構成プロパティが無効か、指定した構成プロパティがアプリケーションに追加されていません。
415 レスポンス
受入れできません
メディア・タイプがサポートされていないか指定されていません。
500 レスポンス
サーバーの内部エラーです。
例
次の例では、1つの特定の構成プロパティについて、指定されたEssbaseアプリケーションの構成を更新する方法を示します。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。
cURLコマンドを含むスクリプト
call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/ASOSamp/configurations/IDLETIMEMERGE?links=none" -H Accept:application/json -H Content-Type:application/json -d '{"value": "FALSE", "configured": true}' -u %User%:%Password%レスポンス本体の例
次の例では、レスポンス本体の内容をJSON形式で示します。
{
"key" : "IDLETIMEMERGE",
"value" : "FALSE",
"configured" : false
}