RetrieveAttributeChangeHistoryRequest Class

Artikel
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveAttributeChangeHistoryRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveAttributeChangeHistoryRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	RetrieveAttributeChangeHistoryRequest()	Initializes a new instance of the RetrieveAttributeChangeHistoryRequest class.

Properties

	Name	Description
	AttributeLogicalName	Gets or sets the attribute’s logical (schema) name. 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.)
	PagingInfo	Gets or sets the paging information. Optional.
	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.)
	Target	Gets or sets the target audit record for which to retrieve attribute change history. Required.

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 RetrieveAttributeChangeHistoryResponse.

Privileges and Access Rights

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

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.


// 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

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.

Bagikan melalui