SetRelatedRequest Class

Article
06/20/2014

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

Contains the data needed to create a relationship between a set of records that participate in specific relationships.

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

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

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of SetRelatedResponse.

Privileges and Access Rights

To perform this action, the caller must have access rights on the records specified in the Target property. For a list of the privileges required, see SetRelated Privileges.

Notes for Callers

This message works for a limited set of relationships and will be deprecated in a future version. Use AssociateRequest instead.

Executing this message when the relationship already exists will result in an error.

Supported Relationships

The following table shows which relationships support this message.

Entity	Relationship Schema Name
Invoice	contactinvoices_association
Lead	accountleads_association contactleads_association
Opportunity	opportunity_customer_accounts opportunitycompetitors_association opportunity_customer_contacts
Product	competitorproduct_association leadproduct_association
Quote	contactquotes_association
SalesLiterature	competitorsalesliterature_association productsalesliterature_association
SalesOrder	contactorders_association

Inheritance Hierarchy

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

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