Documentation Center

start

Initiates an audit trail session for a user. An audit trail XML resource is created within the database.

Description

An audit trail is not always created for a user. An audit trail is usually created the first time the user executes an event which is audited, such as opening a document, running a search, or logging in as a non-anonymous user.

Parameters

action
start

Example URL

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

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

In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>). Refer to API Error Code Reference.