Jump to

• Request
• Response
• Examples

Update Property Values

put

/essbase/rest/v1/properties

Updates Provider Services configuration property values in the Essbase Server, and returns the list of updated properties.

Request

Supported Media Types

• application/json
• application/xml

Body ()

List of property entries.

Root Schema : schema

Type: array

Show Source

• Array of: object PropertyEntry

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

Nested Schema : PropertyEntry

Type: object

Show Source

• links(optional): array links
• name(optional): string
• value(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Properties updated successfully, returning details and links to get or edit the properties.

Body ()

Root Schema : PropertyEntry

Type: object

Show Source

• links(optional): array links
• name(optional): string
• value(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

400 Response

Bad Request

Failed to update properties. The property JSON may be incorrect, or the given property names may already be added to the server.

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 update more than one Provider Services property configurations 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?links=none" -H Accept:application/json -H Content-Type:application/json -d '[{"name": "essbase.jobs.maxCount", "value": "15"},{"name": "olap.server.netRetryCount", "value": "2900"}]' -u %User%:%Password%

Example of Response Body

[ {
  "name" : "essbase.jobs.maxCount",
  "value" : "15"
}, {
  "name" : "olap.server.netRetryCount",
  "value" : "2900"
} ]

Back to Top