DuplicateRule entity messages and methods

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

A duplicate rule is a rule based on which duplicate records are detected for a specified entity type. The schema name for this entity is DuplicateRule. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

AssignRequest

Assigns a duplicate rule to another user or team.

AssociateRequest

Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the duplicate rule entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

CompoundCreateRequest

Deprecated. Use the CreateRequest class.

Creates a duplicate rule and its related duplicate rule conditions.

CompoundUpdateDuplicateDetectionRuleRequest

Updates a duplicate rule and its related duplicate rule conditions.

CreateRequest

Creates a duplicate rule. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a duplicate rule. You can also call the IOrganizationService.Delete method.

DisassociateRequest

Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService. Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the duplicate rule entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

GrantAccessRequest

Shares a duplicate rule with another security principal (user or team).

InitializeFromRequest

Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.

ModifyAccessRequest

Changes the access rights for a duplicate rule previously shared with another security principal (user or team).

PublishDuplicateRuleRequest

Publishes the duplicate rule.

RetrieveDuplicatesRequest

Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.

RetrieveRequest

Retrieves a duplicate rule. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of duplicate rules. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access that the specified security principal (user or team) has to a duplicate rule.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a duplicate rule, and their access rights to the duplicate rule.

RevokeAccessRequest

Revokes the access rights for a duplicate rule for the specified security principal (user or team).

UnpublishDuplicateRuleRequest

Unpublishes a duplicate rule.

UpdateRequest

Updates a duplicate rule. You can also call the IOrganizationService.Update method.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Show: