RetrieveDuplicatesRequest RetrieveDuplicatesRequest RetrieveDuplicatesRequest RetrieveDuplicatesRequest Class


Contains the data that is needed to detect and retrieve duplicates for a specified record.

For the Web API use the RetrieveDuplicates Function.

public ref class RetrieveDuplicatesRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
public sealed class RetrieveDuplicatesRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveDuplicatesRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveDuplicatesRequest
Inherits OrganizationRequest


      var request = new RetrieveDuplicatesRequest
    BusinessEntity = new Account { Name = "Microsoft" }.ToEntity<Entity>(),
    MatchingEntityName = Account.EntityLogicalName,
    PagingInfo = new PagingInfo() { PageNumber = 1, Count = 50 }

Console.WriteLine("Retrieving duplicates");
var response =(RetrieveDuplicatesResponse)svc.Execute(request);

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.



Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the RetrieveDuplicatesResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the entities and the access rights to the specified records in the BusinessEntity property.

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

Notes to Callers

This message works for all entities. Before you use this message, set the IsDuplicateDetectionEnabled attribute for an entity to true and publish all duplicate detection rules for an entity.


RetrieveDuplicatesRequest() RetrieveDuplicatesRequest() RetrieveDuplicatesRequest() RetrieveDuplicatesRequest()

Initializes a new instance of the RetrieveDuplicatesRequest class.


BusinessEntity BusinessEntity BusinessEntity BusinessEntity

Gets or sets a record for which the duplicates are retrieved. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
MatchingEntityName MatchingEntityName MatchingEntityName MatchingEntityName

Gets or sets a name of the matching entity type. Required.

PagingInfo PagingInfo PagingInfo PagingInfo

Gets or sets a paging information for the retrieved duplicates. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also