Jump to

• Request
• Response

Update Outline Settings

patch

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/outline

Updates the outline settings of the specified database.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Body ()

Outline 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

Outline settings updated successfully.

400 Response

Bad Request

Failed to update the settings. The application or database 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