移動先

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

プロパティ値の更新

put

/essbase/rest/v1/properties

EssbaseサーバーのProvider Services構成プロパティの値を更新し、更新されたプロパティのリストを返します。

リクエスト

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

• application/json
• application/xml

本体()

プロパティ・エントリのリスト。

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object PropertyEntry

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

ネストされたスキーマ : 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"
        }
    }
}

先頭に戻る

レスポンス

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

• 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 レスポンス

不正なリクエスト

プロパティの更新に失敗しました。プロパティのJSONが正しくないか、指定したプロパティ名がすでにサーバーに追加されている可能性があります。

415 レスポンス

受入れできません

メディア・タイプがサポートされていないか指定されていません。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseサーバーの複数のProvider Servicesプロパティ構成を更新する方法を示します。

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

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

call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/properties?links=none" -H Accept:application/json -H Content-Type:application/json -d '[{"name": "essbase.jobs.maxCount", "value": "15"},{"name": "olap.server.netRetryCount", "value": "2900"}]' -u %User%:%Password%

レスポンス本体の例

[ {
  "name" : "essbase.jobs.maxCount",
  "value" : "15"
}, {
  "name" : "olap.server.netRetryCount",
  "value" : "2900"
} ]

先頭に戻る