Integration Server 10.11 | Built-In Services Reference Guide | Cache Folder | Summary of Elements in this Folder | pub.cache.admin:clearAllCaches
 
pub.cache.admin:clearAllCaches
WmPublic. Deletes all of the elements from all caches contained in the specified cache manager.
Input Parameters
cacheManagerName
String Name of the cache manager that manages the cache. This parameter is case sensitive.
cachePrefix
String Optional. Prefix of the name of the caches from which to delete elements. If you do not specify a prefix, the service deletes elements from all caches in the cache manager.
Note:
If pub.cache.admin:clearAllCaches does not find any caches with the specified prefix, the service does not clear any caches.
Output Parameters
status
String The status indicating either Error or Success.
message
String The status message.
Usage Notes
Note:
Only users with administrator privileges can execute this service.
Important:
The elements you delete from the caches are deleted permanently. You cannot undo this action.
If pub.cache.admin:clearAllCaches does not find any caches with the specified prefix, the service does not clear any caches, but returns Success for status.
You cannot clear caches managed by system cache managers.
If you have any existing locks on any of the elements in the cache, the pub.cache.admin:clearAllCaches service waits indefinitely until all locks are released.
Integration Server returns a status of Error in the following cases:
*If the cache is managed by a system cache manager.
*If you do not specify all required input parameters.
*If Integration Server cannot find the specified cache manager.
*If a cache operation fails.