RetrieveRecordChangeHistoryRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

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

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

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

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

Constructors

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

Properties

	Name	Description
	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 for the retrieved data. Required.
	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. 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 the RetrieveRecordChangeHistoryResponse class.

Privileges and Access Rights

For a list of the required privileges, see RetrieveRecordChangeHistory message privileges.

Examples


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

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.

Share via