Documentation Center

delete_events

Removes distribution events from the system's event log.

Parameters

action
delete_events
status
The status of events to delete. If set to 'all' then all events will be deleted from the system event log. Other status options in 'success' or 'failed'

Example URL

http://<host>:<port>/<context>/web/package.xql?action=delete_events&status=<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.