移動先

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

アプリケーション構成プロパティの取得

get

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

指定されたアプリケーションから(構成プロパティ名に基づいて)構成を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• configId(required): string

  構成プロパティ名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

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

本体()

ルート・スキーマ : ApplicationConfigEntry

型: 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

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"<p>Filter key to refine the configuration property results. For example if <code>key=A*</code>, all configuration properties beginning with the letter A are returned. Default is *</p>"
        },
        "description":{
            "type":"string",
            "description":"<p>A description of the configuration property.</p>"
        },
        "syntax":{
            "type":"string",
            "description":"<p>The syntax for the configuration property. Example: <code>DATACACHESIZE n</code></p>"
        },
        "example":{
            "type":"string",
            "description":"<p>Usage example for the configuration property. Example: <code>DATACACHESIZE 90M</code></p>"
        },
        "value":{
            "type":"string",
            "description":"<p>Value for the configuration property. Example: <code>1024</code></p>"
        },
        "configured":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the configuration property is enabled. <p>If <b>false</b>, the configuration property is turned off.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

構成情報の取得に失敗しました。アプリケーション名または構成プロパティが無効です。

500 レスポンス

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

先頭に戻る

例

次の例では、特定の構成プロパティ名について、指定されたEssbaseアプリケーションに対して現在設定されている構成を取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/configurations/HYBRIDBSOINCALCSCRIPT?links=none" -u %User%:%Password%

レスポンス本体の例

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

{
  "key" : "HYBRIDBSOINCALCSCRIPT",
  "value" : "FULL",
  "configured" : false
}

先頭に戻る