RetrieveAttributeChangeHistoryRequest Class

 

Updated: November 29, 2016

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

SystemObject
  Microsoft.Xrm.SdkOrganizationRequest
    Microsoft.Crm.Sdk.MessagesRetrieveAttributeChangeHistoryRequest

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodRetrieveAttributeChangeHistoryRequest

Initializes a new instance of the RetrieveAttributeChangeHistoryRequest class.

NameDescription
System_CAPS_pubproperty

Gets or sets the attribute’s logical (schema) name. Required.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the paging information. Optional.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the target audit record for which to retrieve attribute change history. Required.

NameDescription
System_CAPS_pubmethodEquals

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode

(Inherited from Object.)

System_CAPS_pubmethodGetType

(Inherited from Object.)

System_CAPS_pubmethodToString

(Inherited from Object.)

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

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: