移動先

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

アプリケーション構成(フィルタ済)の取得

get

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

指定されたアプリケーションに対して現在設定されているすべての構成プロパティを返します。構成されている値を基準にフィルタすることもできます。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

問合せパラメータ

• configured: string

  構成されているすべてのプロパティを返すには、allを指定します。有効になっている構成プロパティを返すには、trueを指定します。オフになっている構成プロパティを返すには、falseを指定します。

  デフォルト値: all

  指定可能な値: [ "all", "true", "false" ]
• key: string

  構成プロパティ結果を絞り込むためのフィルタ・キー。

  デフォルト値: *

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

構成プロパティを正常に取得しました。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object ApplicationConfigList

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

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

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationConfigEntry"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

• 配列: object ApplicationConfigEntry

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

ネストされたスキーマ : 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/configurationkeys?links=none&configured=true&key=*CACHESIZE" -u %User%:%Password%

レスポンス本体の例

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

{
  "items" : [ {
    "key" : "ASODEFAULTCACHESIZE",
    "description" : "Set the default size for the aggregate storage cache associated with aggregate storage databases",
    "syntax" : "ASODEFAULTCACHESIZE n",
    "example" : "ASODEFAULTCACHESIZE 200",
    "configured" : false
  }, {
    "key" : "DATACACHESIZE",
    "description" : "Define the value for the data cache size for Essbase databases.",
    "syntax" : "DATACACHESIZE n",
    "example" : "DATACACHESIZE 90M",
    "configured" : false
  }, {
    "key" : "INDEXCACHESIZE",
    "description" : "Define the value for the index cache size for Essbase databases.",
    "syntax" : "INDEXCACHESIZE n",
    "example" : "INDEXCACHESIZE 100M",
    "configured" : false
  }, {
    "key" : "MAXFORMULACACHESIZE",
    "description" : "Specify the maximum size of the formula cache to be made available for calculating members with formulas.",
    "syntax" : "MAXFORMULACACHESIZE [dbname] n",
    "example" : "MAXFORMULACACHESIZE 2048",
    "configured" : false
  } ]
}

先頭に戻る