REST API for Oracle Essbase

Update Server Property

put

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

Updates a Provider Services property in the Essbase Server, and returns the updated property.

Request

Supported Media Types

application/json
application/xml

Path Parameters

propertyName(required): string

Property name.

Property entry.

Root Schema : PropertyEntry

Type: object

Show Source

links: array links
name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Property updated successfully, with links to get or edit the property.

Root Schema : PropertyEntry

Type: object

Show Source

links: array links
name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to update the property. The JSON for the property may be incorrect, or the specified property name may not have been added to the server.

415 Response

Not Acceptable

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

500 Response

Internal Server Error.

Examples

The following example shows how to update a Provider Services property configuration for the Essbase Server.

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 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%

Example of Response Body

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