An audit trail provides information about who made changes to a particular record, and when.


List Standard Object Record Audit Trail Logs

getAuditTrail

List all audit trail logs for the given record.

<getAuditTrail>
    <object>APBILL</object>
    <recordNo>1</recordNo>
</getAuditTrail>

Parameters

Name Required Type Description
object Required string Any valid audited object type.
recordNo Optional integer The RECORDNO for the record to get. Required if not using objectKey.
objectKey Optional string The unique name field of the object (for example, for LOCATION, the name field is LOCATIONID). Required if not using recordNo.

Note: If no information is returned, it means the record was created (or last modified) before the audit trail feature was implemented.


List Custom Object Record Audit Trail Logs

readByQuery

List audit trail logs for all records on April 19, 2012

<readByQuery>
    <object>ACTIVITYLOG</object>
    <fields>*</fields>
    <query>OBJ_ID &gt; 10000 AND CREATED_AT &gt;= '04/19/2012 12:00:00' AND CREATED_AT &lt; '04/20/2012 12:00:00'</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ACTIVITYLOG
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

query

Name Required Type Description
OBJ_ID Required integer ID of the record. All record ID’s begin above 10000. Use the record’s id value or find it on the record view’s System Information tab in the UI.
CREATED_BY Optional integer Created by user record number
CREATEDBYUSER Optional string Created by user ID
CREATED_AT Optional datetime Created at timestamp in format mm/dd/yyyy hh:mm:ss

Response

The above function returns data structured like this:

<activitylog>
    <RECORDNO>11034</RECORDNO>
    <OBJ_ID>10049</OBJ_ID>
    <TRAIL_TEXT>Value of &quot;Name&quot; field has been changed from &quot;Test1&quot; to &quot;Test2&quot;.</TRAIL_TEXT>
    <EMAIL_TEXT></EMAIL_TEXT>
    <CREATED_BY>4</CREATED_BY>
    <CREATEDBYUSER>jsmith</CREATEDBYUSER>
    <CREATED_AT>04/19/2012 15:50:05</CREATED_AT>
</activitylog>

Get Custom Object Record Audit Trail Logs

read

<read>
    <object>ACTIVITYLOG</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ACTIVITYLOG
keys Required string The log RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Provide feedback