BulkDetectDuplicatesRequest Class

Definition

Namespace:

Microsoft.Crm.Sdk.Messages

Assembly:

Microsoft.Crm.Sdk.Proxy.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.0.39

Contains the data that is needed to submit an asynchronous system job that detects and logs multiple duplicate records.

For the Web API use the BulkDetectDuplicates Action.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises)

public ref class BulkDetectDuplicatesRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class BulkDetectDuplicatesRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type BulkDetectDuplicatesRequest = class
    inherit OrganizationRequest

Public NotInheritable Class BulkDetectDuplicatesRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

BulkDetectDuplicatesRequest

Attributes

DataContractAttribute

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.

Remarks

Usage

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

Privileges and Access Rights

To perform this action, the caller must have access rights on the entity records that are specified in the request class. For a complete list of the required privileges, see BulkDetectDuplicates message privileges.

Notes for Callers

The asynchronous system job detects multiple duplicate records and logs them as duplicate records by using the DuplicateRecord entity. Before you use this message, set the IsDuplicateDetectionEnabled attribute for an entity to true and publish all duplicate rules (duplicate detection rules) for an entity.

Constructors

BulkDetectDuplicatesRequest()

Initializes a new instance of the BulkDetectDuplicatesRequest class.

Properties

CCRecipients	Gets or sets an array of IDs for the system users (users) who are listed in the Cc box of the email notification.
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)
JobName	Gets or sets the name of the asynchronous system job that detects and logs multiple duplicate records. Required.
Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
Query	Gets or sets the query criteria for detecting multiple duplicate records. Required.
RecurrencePattern	Gets or sets the recurrence pattern for the asynchronous system job that detects multiple duplicate records. Optional.
RecurrenceStartTime	Gets or sets the start date and time of an asynchronous system job that detects and logs multiple duplicate records. Optional.
RequestId	Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
SendEmailNotification	Gets or sets a value that indicates whether an email notification is sent after the asynchronous system job that detects multiple duplicate records finishes running. Required.
TemplateId	Sets the ID of the template (email template) that is used for the email notification.
ToRecipients	Gets or sets an array of IDs for the system users (users) who are listed in the “To” box (recipients) of the email notification.

See also

• BulkDetectDuplicatesResponse