RetrieveRecordChangeHistoryRequest Class

  • Article

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

Contains the data that is needed to retrieve all attribute data changes for a specific entity.

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 RetrieveRecordChangeHistoryRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveRecordChangeHistoryRequest : OrganizationRequest

Example

// Retrieve the audit history for the account and display it.
RetrieveRecordChangeHistoryRequest changeRequest = new RetrieveRecordChangeHistoryRequest();
changeRequest.Target = new EntityReference(Account.EntityLogicalName, _newAccountId);

RetrieveRecordChangeHistoryResponse changeResponse =
    (RetrieveRecordChangeHistoryResponse)_service.Execute(changeRequest);

AuditDetailCollection details = changeResponse.AuditDetailCollection;


' Retrieve the audit history for the account and display it.
Dim changeRequest As New RetrieveRecordChangeHistoryRequest()
changeRequest.Target = New EntityReference(Account.EntityLogicalName, _newAccountId)

Dim changeResponse As RetrieveRecordChangeHistoryResponse = CType(_service.Execute(changeRequest), RetrieveRecordChangeHistoryResponse)

Dim details As AuditDetailCollection = changeResponse.AuditDetailCollection

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 RetrieveRecordChangeHistoryResponse class.

Privileges and Access Rights

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

Inheritance Hierarchy

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

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

RetrieveRecordChangeHistoryRequest Members
Microsoft.Crm.Sdk.Messages Namespace

Other Resources

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

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