Jump to

• Request
• Response
• Examples

Update Application Configurations

put

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

Updates the application configurations and returns the updated configuration details.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationName: string

  Application name.

Body ()

Configuration property value entries.

Root Schema : schema

Type: array

Show Source

• Array of: object ApplicationConfigEntry

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

Nested Schema : ApplicationConfigEntry

Type: object

Show Source

• configured(optional): boolean

  If true, the configuration property is enabled.

  If false, the configuration property is turned off.

• description(optional): string

  A description of the configuration property.

• example(optional): string

  Usage example for the configuration property. Example: DATACACHESIZE 90M

• key(optional): string

  Filter key to refine the configuration property results. For example if key=A*, all configuration properties beginning with the letter A are returned. Default is *

• links(optional): array links
• syntax(optional): string

  The syntax for the configuration property. Example: DATACACHESIZE n

• value(optional): string

  Value for the configuration property. Example: 1024

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"<p>Filter key to refine the configuration property results. For example if <code>key=A*</code>, all configuration properties beginning with the letter A are returned. Default is *</p>"
        },
        "description":{
            "type":"string",
            "description":"<p>A description of the configuration property.</p>"
        },
        "syntax":{
            "type":"string",
            "description":"<p>The syntax for the configuration property. Example: <code>DATACACHESIZE n</code></p>"
        },
        "example":{
            "type":"string",
            "description":"<p>Usage example for the configuration property. Example: <code>DATACACHESIZE 90M</code></p>"
        },
        "value":{
            "type":"string",
            "description":"<p>Value for the configuration property. Example: <code>1024</code></p>"
        },
        "configured":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the configuration property is enabled. <p>If <b>false</b>, the configuration property is turned off.</p>"
        },
        "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

Configurations were updated successfully. Returns the configuration details and the links to get, edit, or delete the configurations.

Body ()

Root Schema : ApplicationConfigList

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationConfigEntry"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ApplicationConfigEntry

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : ApplicationConfigEntry

Type: object

Show Source

• configured(optional): boolean

  If true, the configuration property is enabled.

  If false, the configuration property is turned off.

• description(optional): string

  A description of the configuration property.

• example(optional): string

  Usage example for the configuration property. Example: DATACACHESIZE 90M

• key(optional): string

  Filter key to refine the configuration property results. For example if key=A*, all configuration properties beginning with the letter A are returned. Default is *

• links(optional): array links
• syntax(optional): string

  The syntax for the configuration property. Example: DATACACHESIZE n

• value(optional): string

  Value for the configuration property. Example: 1024

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"<p>Filter key to refine the configuration property results. For example if <code>key=A*</code>, all configuration properties beginning with the letter A are returned. Default is *</p>"
        },
        "description":{
            "type":"string",
            "description":"<p>A description of the configuration property.</p>"
        },
        "syntax":{
            "type":"string",
            "description":"<p>The syntax for the configuration property. Example: <code>DATACACHESIZE n</code></p>"
        },
        "example":{
            "type":"string",
            "description":"<p>Usage example for the configuration property. Example: <code>DATACACHESIZE 90M</code></p>"
        },
        "value":{
            "type":"string",
            "description":"<p>Value for the configuration property. Example: <code>1024</code></p>"
        },
        "configured":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the configuration property is enabled. <p>If <b>false</b>, the configuration property is turned off.</p>"
        },
        "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 the configurations. The application name or configuration entries is invalid, or the given configuration property has not been added to the application.

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 the configuration currently set for the specified Essbase application. You can use an array to update multiple ocnfiguration properties at once.

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_Dynamic/configurations?links=none" -H Accept:application/json -H Content-Type:application/json --data "@./updateconfigs.json" -u %User%:%Password%

Input JSON Data

The script above executes, on Sample_Dynamic Basic, the application configuration array specified in updateconfigs.json. The input file has the following contents:

[
  {
    "key" : "HYBRIDBSOINCALCSCRIPT",
    "value" : "NONE",
    "configured" : true
  }, {
    "key" : "ASODYNAMICAGGINBSO",
    "value" : "FULL",
    "configured" : true
  } 
]

Example of Response Body

The following example shows the contents of the response body in JSON format.

[ {
  "key" : "HYBRIDBSOINCALCSCRIPT",
  "value" : "NONE",
  "configured" : false
}, {
  "key" : "ASODYNAMICAGGINBSO",
  "value" : "FULL",
  "configured" : false
} ]

Back to Top