SetRelatedRequest Class

 

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SetRelatedRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class SetRelatedRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type SetRelatedRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SetRelatedRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod SetRelatedRequest()

Initializes a new instance of the SetRelatedRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

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

System_CAPS_pubproperty Item[String]

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

System_CAPS_pubproperty Parameters

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

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

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

System_CAPS_pubproperty Target

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

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

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.

See Also

AssociateRequest
SetRelatedResponse
Microsoft.Crm.Sdk.Messages Namespace
Actions on entity records

Return to top

© 2016 Microsoft. All rights reserved. Copyright