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
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveAuditDetailsRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveAuditDetailsRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveAuditDetailsRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RetrieveAuditDetailsRequest() | Initializes a new instance of the RetrieveAuditDetailsRequest class. |
Properties
Name | Description | |
---|---|---|
AuditId | Gets or sets the ID of the Audit record to retrieve. Required. |
|
ExtensionData | Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.) |
|
Item[String] | Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.) |
|
Parameters | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
|
RequestId | Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.) |
|
RequestName | Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 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.
Examples
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)
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
RetrieveAuditDetailsResponse
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