DeleteAuditDataRequest Class
Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online
Contains the data that is needed to delete all audit data records up until a specified end date.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Syntax
'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class DeleteAuditDataRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class DeleteAuditDataRequest : 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.
// Get the list of audit partitions.
RetrieveAuditPartitionListResponse partitionRequest =
(RetrieveAuditPartitionListResponse)_service.Execute(new RetrieveAuditPartitionListRequest());
AuditPartitionDetailCollection partitions = partitionRequest.AuditPartitionDetailCollection;
// Create a delete request with an end date earlier than possible.
DeleteAuditDataRequest deleteRequest = new DeleteAuditDataRequest();
deleteRequest.EndDate = new DateTime(2000, 1, 1);
// Check if partitions are not supported as is the case with SQL Server Standard edition.
if (partitions.IsLogicalCollection)
{
// Delete all audit records created up until now.
deleteRequest.EndDate = DateTime.Now;
}
// Otherwise, delete all partitions that are older than the current partition.
// Hint: The partitions in the collection are returned in sorted order where the
// partition with the oldest end date is at index 0.
else
{
for (int n = partitions.Count - 1; n >= 0; --n)
{
if (partitions[n].EndDate <= DateTime.Now && partitions[n].EndDate > deleteRequest.EndDate)
{
deleteRequest.EndDate = (DateTime)partitions[n].EndDate;
break;
}
}
}
// Delete the audit records.
if (deleteRequest.EndDate != new DateTime(2000, 1, 1))
{
_service.Execute(deleteRequest);
Console.WriteLine("Audit records have been deleted.");
}
else
Console.WriteLine("There were no audit records that could be deleted.");
' Get the list of audit partitions.
Dim partitionRequest As RetrieveAuditPartitionListResponse = CType(_service.Execute(New RetrieveAuditPartitionListRequest()), RetrieveAuditPartitionListResponse)
Dim partitions As AuditPartitionDetailCollection = partitionRequest.AuditPartitionDetailCollection
' Create a delete request with an end date earlier than possible.
Dim deleteRequest As New DeleteAuditDataRequest()
deleteRequest.EndDate = New Date(2000, 1, 1)
' Check if partitions are not supported as is the case with SQL Server Standard edition.
If partitions.IsLogicalCollection Then
' Delete all audit records created up until now.
deleteRequest.EndDate = Date.Now
' Otherwise, delete all partitions that are older than the current partition.
' Hint: The partitions in the collection are returned in sorted order where the
' partition with the oldest end date is at index 0.
Else
For n As Integer = partitions.Count - 1 To 0 Step -1
If partitions(n).EndDate <= Date.Now AndAlso partitions(n).EndDate > deleteRequest.EndDate Then
deleteRequest.EndDate = CDate(partitions(n).EndDate)
Exit For
End If
Next n
End If
' Delete the audit records.
If deleteRequest.EndDate <> New Date(2000, 1, 1) Then
_service.Execute(deleteRequest)
Console.WriteLine("Audit records have been deleted.")
Else
Console.WriteLine("There were no audit records that could be deleted.")
End If
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 will return an instance of DeleteAuditDataResponse.
Privileges and Access Rights
For a list of the privileges required, see DeleteAuditData Privileges.
Notes for Callers
This message behaves slightly different depending on the version of Microsoft SQL Server that is installed on the Microsoft Dynamics CRM server. See Retrieve and Delete the History of Audited Data Changes for more information.
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.DeleteAuditDataRequest
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
DeleteAuditDataRequest Members
Microsoft.Crm.Sdk.Messages Namespace
Other Resources
Audit Entity Data Changes in Microsoft Dynamics CRM
Sample: Audit Entity Data Changes
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.