RetrieveAuditDetailsRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to retrieve the full audit details from an Audit record.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="http://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveAuditDetailsRequest
    Inherits OrganizationRequest
[DataContractAttribute(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveAuditDetailsRequest : OrganizationRequest

Example

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

Console.WriteLine("Retrieving audit details for an audit record.");

// Retrieve the audit details and display them.
var auditDetailsRequest = new RetrieveAuditDetailsRequest
{
    AuditId = auditSampleId
};

var auditDetailsResponse =
    (RetrieveAuditDetailsResponse)_service.Execute(auditDetailsRequest);
Console.WriteLine("Retrieving audit details for an audit record.")

' Retrieve the audit details and display them.
Dim auditDetailsRequest = New RetrieveAuditDetailsRequest With {.AuditId = auditSampleId}

Dim auditDetailsResponse = CType(_service.Execute(auditDetailsRequest), RetrieveAuditDetailsResponse)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveAuditDetailsResponse class.

Privileges and Access Rights

For a list of the required privileges, see RetrieveAuditDetails Privileges.

Notes for Callers

Changes to entity attribute values are stored in an Audit record in a comma-separated value (.csv) file. The RetrieveAuditDetailsResponse class returns the changed data as a data collection.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.RetrieveAuditDetailsRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

RetrieveAuditDetailsRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveAuditDetailsResponse

Other Resources

Retrieve and Delete the History of Audited Data Changes
Audit entity data changes
Sample: Audit Entity Data Changes

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.