Jump to

• Request
• Response
• Examples

Update Application Settings

patch

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

Updates the settings of the specified application.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationName: string

  Application name.

Body ()

Application settings patch list.

Root Schema : schema

Type: array

Show Source

• Array of: object PatchElement

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

Nested Schema : PatchElement

Type: object

Show Source

• from(optional): string
• op(optional): string

  Patch operation. Example: replace.

• path(optional): string

  Path to setting you want to patch. See examples.

• value(optional): object value

  New value of setting you want to patch. See examples.

{
    "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"
        }
    }
}

Nested Schema : value

Type: object

New value of setting you want to patch. See examples.

Back to Top

Response

204 Response

OK

Settings updated successfully.

400 Response

Bad Request

Failed to update the settings. The application name may be incorrect, or the JSON for the settings may be incorrect.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to make updates to Essbase application settings.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

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%

Example of JSON Payload

The file appsettings_patch.json delivers the following payload to patch the application settings.

[
{"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}
]

Back to Top