Documentation Center

garbagecollect

Manually initiates a garbage collection event on the server. This will delete old audits, based on the server's global configuration settings. This is usually initiated by a scheduled job.

Parameters

action
garbagecollect

Example URL

http://<host>:<port>/<context>/web/audit.xql?action=garbagecollect

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.