SetRelatedRequest Class

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, 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)

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

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

NameDescription
System_CAPS_pubmethodSetRelatedRequest()

Initializes a new instance of the SetRelatedRequest class.

NameDescription
System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyItem[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyParameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyTarget

Gets or sets the target records of the set related action. Required.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: