clear_cache
Clears a keyed cache on the application server.
Description
This API call receives requests to clear specific caches, such as the cache for the application config or the cache for language resources.
Parameters
- action
- clear_cache
- key
- A comma-delimited list of keys which identify the application caches to clear. For example, "config.app,skin.lang.all". The valid keys are "config.app" which clears the global config cache, "skin.lang.all" which clears the language resource cache, and "skin.xsl" which clears the compiled XSL cache.
Example URL
http://<host>:<port>/<context>/web/admin.xql?action=clear_cache&key=<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
Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available.