SetRelatedRequest SetRelatedRequest SetRelatedRequest SetRelatedRequest Class

Definition

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

public ref class SetRelatedRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SetRelatedRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type SetRelatedRequest = class
    inherit OrganizationRequest
Public NotInheritable Class SetRelatedRequest
Inherits OrganizationRequest
Inheritance
SetRelatedRequestSetRelatedRequestSetRelatedRequestSetRelatedRequest
Attributes

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(OrganizationRequest) 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

Constructors

SetRelatedRequest() SetRelatedRequest() SetRelatedRequest() SetRelatedRequest()

Initializes a new instance of the SetRelatedRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Target Target Target Target

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

Applies to

See also