移動先

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

サーバー・プロパティの更新

put

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

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

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• propertyName(required): string

  プロパティ名。

本体()

プロパティのエントリ。

ルート・スキーマ : 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/essbase.jobs.maxCount?links=none" -H Accept:application/json -H Content-Type:application/json -d '{"value": "10"}' -u %User%:%Password%

レスポンス本体の例

{
  "name" : "essbase.jobs.maxCount",
  "value" : "10"
}

先頭に戻る