Oracle Essbase REST API

アプリケーション設定の更新

patch

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

指定されたアプリケーションの設定を更新します。

リクエスト

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

application/json
application/xml

パス・パラメータ

applicationName(required): string

アプリケーション名。

アプリケーション設定のパッチのリスト。

ルート・スキーマ : schema

型: array

ソースの表示

配列: object PatchElement

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

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

型: object

ソースの表示

from: string
op: string

パッチ適用操作。例: replace。
path: string

パッチを適用する設定へのパス。例を参照してください。
value: object value

パッチを適用する設定の新しい値。例を参照してください。

{
    "type":"object",
    "properties":{
        "op":{
            "type":"string",
            "description":"<p>Patch operation. Example: <b>replace</b>.</p>"
        },
        "path":{
            "type":"string",
            "description":"<p>Path to setting you want to patch. See examples.</p>"
        },
        "value":{
            "type":"object",
            "description":"<p>New value of setting you want to patch. See examples.</p>"
        },
        "from":{
            "type":"string"
        }
    }
}

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

型: object

パッチを適用する設定の新しい値。例を参照してください。

先頭に戻る

レスポンス

204 レスポンス

設定が正常に更新されました。

400 レスポンス

不正なリクエスト

設定の更新に失敗しました。アプリケーション名が正しくないか、設定のJSONが正しくない可能性があります。

415 レスポンス

受入れできません

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

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseアプリケーション設定を更新する方法を示します。

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

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

call properties.bat
curl -X PATCH "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/settings?links=none" -H "Accept:application/json" -H "Content-Type:application/json" --data "@./appsettings_patch.json" -u %User%:%Password%

JSONペイロードの例

ファイルappsettings_patch.jsonは、アプリケーション設定にパッチを適用する次のペイロードを配信します。

[
{"op":"replace", "path":"/general/description", "value": "Patch Description"},
{"op":"replace", "path":"/startup/startApplicationWhenServerStarts", "value": true},
{"op":"replace", "path":"/security/allowCommands", "value": false},
{"op":"replace", "path":"/security/allowConnects", "value": true},
{"op":"replace", "path":"/security/allowUpdates", "value": false},
{"op":"replace", "path":"/general/easManagedApp", "value": false}
]

先頭に戻る