移動先

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

サーバー・プロパティの取得

get

/essbase/rest/v1/properties/{propertyName}

指定されたプロパティをサーバーから返します。

リクエスト

パス・パラメータ

• propertyName(required): string

  プロパティ名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

プロパティの名前および値が正常に返されました。プロパティを取得または編集するためのリンクが含まれています。

本体()

ルート・スキーマ : PropertyEntry

型: object

ソースの表示

• links: array links
• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "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サーバーに構成されている指定されたProvider Servicesプロパティをリストする方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/properties/olap.server.netRetryCount?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

レスポンス本体の例

{
  "name" : "olap.server.netRetryCount",
  "value" : "2950"
}

先頭に戻る