MergeRequest Class

Article
06/20/2014

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

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

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 MergeRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class MergeRequest : 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.

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

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

Inheritance Hierarchy

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

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),

Share via

MergeRequest Class

Syntax

Example

Remarks

Merge Incidents

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources