PublishDuplicateRuleRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to submit an asynchronous job to publish a duplicate rule.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class PublishDuplicateRuleRequest
    Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class PublishDuplicateRuleRequest : OrganizationRequest

Example

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.

// Retrieve all rules for the entity
var rules = _serviceProxy.RetrieveMultiple(
    new QueryByAttribute(DuplicateRule.EntityLogicalName)
{
    ColumnSet = new ColumnSet("duplicateruleid"),
    Attributes = { "matchingentityname" },
    Values = { entityName }
});

List<Guid> crmAsyncOperationIds = new List<Guid>();
foreach (var item in rules.Entities)
{
    Console.WriteLine(String.Concat("Publishing duplicate rule: ", item.Id));

    // Publish each rule and get the job id since it is async
    var response = (PublishDuplicateRuleResponse)_serviceProxy.Execute(
            new PublishDuplicateRuleRequest { DuplicateRuleId = item.Id });

    crmAsyncOperationIds.Add(response.JobId);
}

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the DuplicateRule entity and access rights on the record specified in the DuplicateRuleId property.

For a complete list of the required privileges, see PublishDuplicateRule Privileges.

Notes for Callers

A duplicate rule publishing job creates a matchcode for every entity record that a duplicate detection rule applies to. The matchcode is used as a part of the process for detecting duplicates.

Inheritance Hierarchy

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

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

PublishDuplicateRuleRequest Members
Microsoft.Crm.Sdk.Messages Namespace
PublishDuplicateRuleResponse

Other Resources

PublishDuplicateRule Privileges
Sample: Enable Duplicate Detection and Retrieve Duplicates
Detect Duplicate Data in Microsoft Dynamics CRM
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.