アプリケーション構成の追加
/essbase/rest/v1/applications/{applicationName}/configurations
構成プロパティをアプリケーションに追加し、追加した構成プロパティの名前を返します。
リクエスト
- application/json
- application/xml
- applicationName(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 レスポンス
不正なリクエスト
構成プロパティの追加に失敗しました。アプリケーション名または構成プロパティのJSONが正しくないか、構成プロパティがすでにアプリケーションに追加されている可能性があります。
415 レスポンス
受入れできません
メディア・タイプがサポートされていないか指定されていません。
500 レスポンス
サーバーの内部エラーです。
例
次の例では、特定の構成プロパティ名について、指定されたEssbaseアプリケーションに対して現在設定されている構成を取得する方法を示します。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat
内でその変数値が設定されています。
cURLコマンドを含むスクリプト
call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/ASOSamp/configurations?links=none" -H Accept:application/json -H Content-Type:application/json -d '{"key": "IDLETIMEMERGE", "value": "TRUE", "configured": false}' -u %User%:%Password%
レスポンス本体の例
次の例では、レスポンス本体の内容をJSON形式で示します。
{
"key" : "IDLETIMEMERGE",
"value" : "TRUE",
"configured" : false
}