REST API for Oracle Essbase

Update Application Variable

put

/essbase/rest/v1/applications/{applicationName}/variables/{variableName}

Updates the substitution variable in the specified application, and returns the updated variable.

Request

Supported Media Types

application/json
application/xml

Path Parameters

applicationName(required): string

Application name.
variableName(required): string

Variable name.

Variable details.

Root Schema : Variable

Type: object

Show Source

appName: string
dbName: string
links: array links
name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "appName":{
            "type":"string"
        },
        "dbName":{
            "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

Variable updated successfully, with links to get, edit, or delete.

Root Schema : Variable

Type: object

Show Source

appName: string
dbName: string
links: array links
name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "appName":{
            "type":"string"
        },
        "dbName":{
            "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 variable. The application name may be incorrect, the JSON for the variable may be incorrect, or the specified variable name may not exist.

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 an Essbase application-level variable.

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/applications/Sample/variables/CurrMonth?links=none" -H Accept:application/json -H Content-Type:application/json -d '{"value": "Oct"}' -u %User%:%Password%

Example of Response Body

{
  "name" : "CurrMonth",
  "value" : "Oct"
}