RetrieveAuditDetailsRequest Class


Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, 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)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class RetrieveAuditDetailsRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class RetrieveAuditDetailsRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod RetrieveAuditDetailsRequest()

Initializes a new instance of the RetrieveAuditDetailsRequest class.


Name Description
System_CAPS_pubproperty AuditId

Gets or sets the ID of the Audit record to retrieve. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

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


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 message 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.


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 =

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)

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.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Retrieve and delete the history of audited data changes
Audit entity data changes
Sample: Audit entity data changes

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright