Audit Entity Reference

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

Messages

Message Web API Operation SDK Assembly
DeleteAuditData DeleteAuditData Action DeleteAuditDataRequest
DeleteRecordChangeHistory DeleteRecordChangeHistory Action DeleteRecordChangeHistoryRequest
Retrieve GET [org URI]/api/data/v9.0/audits(auditid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveAttributeChangeHistory RetrieveAttributeChangeHistory Function RetrieveAttributeChangeHistoryRequest
RetrieveAuditDetails RetrieveAuditDetails Function RetrieveAuditDetailsRequest
RetrieveAuditPartitionList RetrieveAuditPartitionList Function RetrieveAuditPartitionListRequest
RetrieveMultiple GET [org URI]/api/data/v9.0/audits
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrieveRecordChangeHistory RetrieveRecordChangeHistory Function RetrieveRecordChangeHistoryRequest

Entity Properties

Property Value
CollectionSchemaName Audit
DisplayCollectionName Audits
DisplayName Auditing
EntitySetName audits
IsBPFEntity False
LogicalCollectionName audits
LogicalName audit
OwnershipType None
PrimaryIdAttribute auditid
PrimaryNameAttribute
SchemaName Audit

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

RegardingObjectId

Property Value
Description Unique identifier of the object with which the record is associated.
DisplayName Regarding
IsValidForForm True
IsValidForRead True
LogicalName regardingobjectid
RequiredLevel None
Targets
Type Lookup

RegardingObjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectidname
MaxLength 400
RequiredLevel None
Type String

UserAdditionalInfo

Property Value
Description Additional information associated to the user who caused the change.
DisplayName User Info
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName useradditionalinfo
MaxLength 350
RequiredLevel None
Type String

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

Action

Property Value
Description Actions the user can perform that cause a change
DisplayName Event
IsValidForForm False
IsValidForRead True
LogicalName action
RequiredLevel ApplicationRequired
Type Picklist

Action Options

Value 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

AttributeMask

Property Value
Description Contains a CSV of the ColumnNumber metadata property of attributes
DisplayName Changed Field
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName attributemask
MaxLength 2000
RequiredLevel None
Type Memo

AuditId

Property Value
Description Unique identifier of the auditing instance
DisplayName Record Id
IsValidForForm False
IsValidForRead True
LogicalName auditid
RequiredLevel SystemRequired
Type Uniqueidentifier

CallingUserId

Property Value
Description Unique identifier of the calling user in case of an impersonated call
DisplayName Calling User
IsValidForForm False
IsValidForRead True
LogicalName callinguserid
RequiredLevel None
Targets systemuser
Type Lookup

CallingUserIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName callinguseridname
MaxLength 100
RequiredLevel None
Type String

ChangeData

Property Value
Description Contains a CSV of old values of all the attributes whose IsAuditEnabled property is True and are being changed
DisplayName Change Data
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead False
LogicalName changedata
MaxLength 2000
RequiredLevel None
Type Memo

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the audit record was created.
DisplayName Changed Date
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel SystemRequired
Type DateTime

ObjectId

Property Value
Description Unique identifier of the record that is being audited
DisplayName Record
IsValidForForm False
IsValidForRead True
LogicalName objectid
RequiredLevel SystemRequired
Targets
Type Lookup

ObjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName objectidname
MaxLength 160
RequiredLevel None
Type String

ObjectTypeCode

Property Value
Description Unique identifier of the entity that is being audited
DisplayName Entity
IsValidForForm False
IsValidForRead True
LogicalName objecttypecode
RequiredLevel None
Type EntityName

Operation

Property Value
Description The action that causes the audit--it will be create, delete, or update
DisplayName Operation
IsValidForForm False
IsValidForRead True
LogicalName operation
RequiredLevel SystemRequired
Type Picklist

Operation Options

Value Label
1 Create
2 Update
3 Delete
4 Access

TransactionId

Property Value
Description 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
DisplayName Transaction Id
IsValidForForm False
IsValidForRead True
LogicalName transactionid
RequiredLevel SystemRequired
Type Uniqueidentifier

UserId

Property Value
Description Unique identifier of the user who caused a change
DisplayName Changed By
IsValidForForm False
IsValidForRead True
LogicalName userid
RequiredLevel SystemRequired
Targets externalparty,systemuser
Type Lookup

UserIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName useridname
MaxLength 100
RequiredLevel None
Type String

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_audit_userid

See systemuser Entity lk_audit_userid One-To-Many relationship.

lk_audit_callinguserid

See systemuser Entity lk_audit_callinguserid One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
audit EntityType