Documentation Center

clear_cache

Clears cached resources.

Description

If pub and lang are provided, clears cache for that language version; if neither are provided, clears caches for all pubs.

Parameters

action
clear_cache
lang
A language version of a publication.
pub
A publication, which is a logical grouping of information (topics and multimedia) related to a specific subject, containing one or more language versions.

Example URL

http://<host>:<port>/<context>/web/pub.xql?action=clear_cache&lang=<value>&pub=<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 pubs" permission, and the function will throw a permission exception if the permission is not available.