list

Queries the database for all available audit trails, and returns a list of these audits in either HTML or XML format.

Parameters

action
list
scope
Scope of audit data to be listed (defaults to all), e.g. 'aggregate' for aggregated audit data.
start
The index of the first audit trail to return. Defaults to 1.
length
The number of audit trails to return. Defaults to 20.
format
The output format for the results. Either "html" or "xml". Defaults to "html"

Example URL

http://<host>:<port>/<context>/web/audit.xql?action=list&scope=<value>&start=<value>&length=<value>&format=<value>

Successful Result

If the format parameter is set to HTML, this function returns an HTML page listing the audits requested, links to view the audits, and a pager to move through the list. If the format parameter is set to XML, a shortened XML instance is returned that gives the metadata of each audit trail, including the session ID, which can be used to load each audit individually using the get action.

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.