PublishDuplicateRuleRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

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

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

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

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

Constructors

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

Properties

	Name	Description
	DuplicateRuleId	Gets or sets the ID of the duplicate rule to be published. Required.
	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.)
	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.)

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

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.


// 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);
}

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