audit EntityType

Track changes to records for analysis, record keeping, and compliance.

Entity Set Path
[organization URI]/api/data/v9.2/audits
Base Type
Display Name
Primary Key
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
action Edm.Int32

Actions the user can perform that cause a change

Display Name: Event

Read Only
Default Options
Values Label
0 Unknown
1 Create
2 Update
3 Delete
4 Activate
5 Deactivate
11 Cascade
12 Merge
13 Assign
14 Share
15 Retrieve
16 Close
17 Cancel
18 Complete
20 Resolve
21 Reopen
22 Fulfill
23 Paid
24 Qualify
25 Disqualify
26 Submit
27 Reject
28 Approve
29 Invoice
30 Hold
31 Add Member
32 Remove Member
33 Associate Entities
34 Disassociate Entities
35 Add Members
36 Remove Members
37 Add Item
38 Remove Item
39 Add Substitute
40 Remove Substitute
41 Set State
42 Renew
43 Revise
44 Win
45 Lose
46 Internal Processing
47 Reschedule
48 Modify Share
49 Unshare
50 Book
51 Generate Quote From Opportunity
52 Add To Queue
53 Assign Role To Team
54 Remove Role From Team
55 Assign Role To User
56 Remove Role From User
57 Add Privileges to Role
58 Remove Privileges From Role
59 Replace Privileges In Role
60 Import Mappings
61 Clone
62 Send Direct Email
63 Enabled for organization
64 User Access via Web
65 User Access via Web Services
100 Delete Entity
101 Delete Attribute
102 Audit Change at Entity Level
103 Audit Change at Attribute Level
104 Audit Change at Org Level
105 Entity Audit Started
106 Attribute Audit Started
107 Audit Enabled
108 Entity Audit Stopped
109 Attribute Audit Stopped
110 Audit Disabled
111 Audit Log Deletion
112 User Access Audit Started
113 User Access Audit Stopped
6 Upsert
115 Archive
116 Retain
117 RollbackRetain
118 IPFirewallAcccesDenied
119 IPFirewallAcccesAllowed
120 Restore
121 ApplicationBasedAccessDenied
122 ApplicationBasedAccessAllowed
attributemask Edm.String

Contains a CSV of the ColumnNumber metadata property of attributes

Display Name: Changed Field

Read Only
auditid Edm.Guid

Unique identifier of the auditing instance

Display Name: Record Id

Read Only
changedata Edm.String

Contains a CSV of old values of all the attributes whose IsAuditEnabled property is True and are being changed

Display Name: Change Data

Read Only
createdon Edm.DateTimeOffset

Date and time when the audit record was created.

Display Name: Changed Date

Read Only
objecttypecode Edm.String

Unique identifier of the entity that is being audited

Display Name: Entity

Read Only
operation Edm.Int32

The action that causes the audit--it will be create, delete, update, upsert or archive

Display Name: Operation

Read Only
Default Options
Values Label
1 Create
2 Update
3 Delete
4 Access
5 Upsert
115 Archive
116 Retain
117 RollbackRetain
118 Restore
200 CustomOperation
transactionid Edm.Guid

Unique identifier for multiple changes that are part of a single operation; this field contains the same GUID for all the audit rows generated in a single transaction

Display Name: Transaction Id

Read Only
useradditionalinfo Edm.String

Additional information associated to the user who caused the change.

Display Name: User Info

versionnumber Edm.Int64

Version number of the audit.

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_callinguserid_value callinguserid

Unique identifier of the calling user in case of an impersonated call

_userid_value userid

Unique identifier of the user who caused a change

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
callinguserid systemuser lk_audit_callinguserid
userid systemuser lk_audit_userid


The following operations can be used with the audit entity type.

Name Binding
DeleteAuditData Not Bound
DeleteRecordChangeHistory Not Bound
RetrieveAttributeChangeHistory Not Bound
RetrieveAuditDetails Bound to Entity
RetrieveAuditPartitionList Not Bound
RetrieveRecordChangeHistory Not Bound

See also