Documentation Center

set

If an item exists this function will update it. If it does not exist, a new item will be created.

Parameters

action
set
name
The name of the global config item.
value
The value to be set for the global config item.

Example URL

http://<host>:<port>/<context>/web/app_config.xql?action=set&name=<value>&value=<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.