audit EntityType
Track changes to records for analysis, record keeping, and compliance.
- Entity Set Path
- [organization URI]/api/data/v9.2/audits
- Base Type
- crmbaseentity
- Display Name
- Auditing
- Primary Key
- auditid
- Operations Supported
- GET
Properties
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
Operations
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 |