RetrieveAttributeChangeHistoryRequest Class

  • Article

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

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

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

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveAttributeChangeHistoryRequest : 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.

// Update the Telephone1 attribute in the Account entity record.
Account accountToUpdate = new Account();
accountToUpdate.AccountId = _newAccountId;
accountToUpdate.Telephone1 = "123-555-5555";
_serviceProxy.Update(accountToUpdate);
Console.WriteLine("Updated the Telephone1 field in the Account entity.");

// Retrieve the attribute change history.
Console.WriteLine("Retrieving the attribute change history for Telephone1.");

var attributeChangeHistoryRequest = new RetrieveAttributeChangeHistoryRequest
{
    Target = new EntityReference(
        Account.EntityLogicalName, _newAccountId),
    AttributeLogicalName = "telephone1"
};

var attributeChangeHistoryResponse =
    (RetrieveAttributeChangeHistoryResponse)_service.Execute(attributeChangeHistoryRequest);

// Display the attribute change history.
details = attributeChangeHistoryResponse.AuditDetailCollection;


' Update the Telephone1 attribute in the Account entity record.
Dim accountToUpdate As New Account()
accountToUpdate.AccountId = _newAccountId
accountToUpdate.Telephone1 = "123-555-5555"
_serviceProxy.Update(accountToUpdate)
Console.WriteLine("Updated the Telephone1 field in the Account entity.")

' Retrieve the attribute change history.
Console.WriteLine("Retrieving the attribute change history for Telephone1.")

Dim attributeChangeHistoryRequest = New RetrieveAttributeChangeHistoryRequest With {.Target = New EntityReference(Account.EntityLogicalName, _newAccountId), .AttributeLogicalName = "telephone1"}

Dim attributeChangeHistoryResponse = CType(_service.Execute(attributeChangeHistoryRequest), RetrieveAttributeChangeHistoryResponse)

' Display the attribute change history.
details = attributeChangeHistoryResponse.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 RetrieveAttributeChangeHistoryResponse.

Privileges and Access Rights

For a complete list of the privileges required, see RetrieveAttributeChangeHistory Privileges.

Inheritance Hierarchy

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

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

RetrieveAttributeChangeHistoryRequest Members
Microsoft.Crm.Sdk.Messages Namespace

Other Resources

Audit Entity Data Changes in Microsoft Dynamics CRM
Audit Entity Messages and Methods
Sample: Audit Entity Data Changes

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