Documentation Center

get

Returns the value of a global config item, referenced by name. In the case of a JSON object, the entire global config structure will be returned.

Parameters

action
get
name
The name of the global config item. Not required in the case of a "json" format.
format
The output format for the results. Either "json" or "xml". Defaults to "xml".

Example URL

http://<host>:<port>/<context>/web/app_config.xql?action=get&name=<value>&format=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>). Refer to API Error Code Reference.