MergeRequest Class

Articol
11/28/2016

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

Contains the data that’s needed to merge the information from two entity records of the same type.

For the Web API use the Merge Action.

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

Syntax

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

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

Constructors

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

Properties

	Name	Description
	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.)
	PerformParentingChecks	Gets or sets a value that indicates whether to check if the parent information is different for the two entity records. Required.
	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.)
	SubordinateId	Gets or sets the ID of the entity record from which to merge data. Required.
	Target	Gets or sets the target of the merge operation. Required.
	UpdateContent	Gets or sets additional entity attributes to be set during the merge operation for accounts, contacts, or leads. This property is not applied when merging incidents. Optional.

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 the MergeResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges and access rights on the specified entity in the SubordinateId property and privileges on the entity that is referred to in the Target property.

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

Supported Entities

The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available.

Entity
account
contact
lead
incident

For a description of how actions on a parent record affect child records, see Entity relationship behavior.

Merge incidents

The behavior of merge for incidents is different from merging accounts, contacts, or leads in the following ways:

The UpdateContent property is not used.

For other entities this property may be used to transfer selected values from the subordinate record to the target record. When merging incidents the value of this property is ignored.
Merge is performed in the security context of the user.

Merge operations for other entities are performed with a system user security context. Because incident merge operations are performed in the security context of the user, the user must have the security privileges to perform any of the actions, such as re-parenting related records, that are performed by the merge operation.

If the user merging records doesn’t have privileges for all the actions contained within the merge operation, the merge operation will fail and roll back to the original state.

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.


         // Create the target for the request.
EntityReference target = new EntityReference();

// Id is the GUID of the account that is being merged into.
         // LogicalName is the type of the entity being merged to, as a string
target.Id = _account1Id;
         target.LogicalName = Account.EntityLogicalName;

         // Create the request.
         MergeRequest merge = new MergeRequest();
         // SubordinateId is the GUID of the account merging.
         merge.SubordinateId = _account2Id;
         merge.Target = target;
         merge.PerformParentingChecks = false;

         Console.WriteLine("\nMerging account2 into account1 and adding " +
             "\"test\" as Address 1 Line 1");

         // Create another account to hold new data to merge into the entity.
         // If you use the subordinate account object, its data will be merged.
         Account updateContent = new Account();
         updateContent.Address1_Line1 = "test";

         // Set the content you want updated on the merged account
         merge.UpdateContent = updateContent;

         // Execute the request.
         MergeResponse merged = (MergeResponse)_serviceProxy.Execute(merge);

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.

Partajați prin