機械翻訳について

ジャンプ先

• 要求
• レスポンス

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

get

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

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

要求

パス・パラメータ

• applicationName: string

  アプリケーション名

問合せパラメータ

• configured(optional): string

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

  デフォルト値: all

  許可される値: [ "all", "true", "false" ]
• key(optional): string

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

  デフォルト値: *

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

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

本文()

ルート・スキーマ : schema

タイプ: array

Show Source

• Array of: object ApplicationConfigList

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

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

タイプ: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties
• totalResults(optional): integer(int64)

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

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

タイプ: array

Show Source

• Array of: object ApplicationConfigEntry

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

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

タイプ: object

許可される追加プロパティ

Show Source

• string

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

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

タイプ: object

Show Source

• configured(optional): boolean
• description(optional): string
• example(optional): string
• key(optional): string
• links(optional): array links
• syntax(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "syntax":{
            "type":"string"
        },
        "example":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "configured":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object Link

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

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

400 レスポンス

不正なリクエスト

構成プロパティの取得に失敗しました。 アプリケーション名が正しくない可能性があります。

500 レスポンス

内部サーバー・エラー。

先頭に戻る