auditService

A web service for logging and retrieving messages using the application audit feature. In the admin console, audit messages can be view at System > Management > Audit Log Viewer. The audit log captures actions made in the admin console.

For soap services this service can be accessed at /rpc/soap/AuditService For rest services this service can be accessed at /rpc/rest/audit .

Method	Description
auditEvent	Logs an event with formatted data passed.
getAuditMessages	Returns a list of audit logs entries.

auditEvent

Logs an event with formatted data passed.

POST http://domain:port/application_context/rpc/rest/auditService/audit

Arguments

Name	Type	Description
username	xs:string	The name of user, usually the one performing the action.
description	xs:string	A summary of the event, typically very brief.
details	xs:string	The details of the method call.

Arguments Template

<auditEvent> 
    <username>xs:string</username>
    <description>xs:string</description>
    <details>xs:string</details>
</auditEvent>

Errors

Error	When Returned
UserNotFound	If username does not correspond to a user in the system.
Unauthorized	If the caller is not an administrator.

getAuditMessages

Returns a list of audit logs entries.

GET http://domain:port/application_context/rpc/rest/auditService/audit

Response

Type	Description
List of AuditMessage	A list of audit messages.

Response Template

<getAuditMessagesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of AuditMessage -->
    <return>
</getAuditMessagesResponse>

Errors

Error	When Returned
Unauthorized	If the caller is not an administrator.