AssociateRequest Class

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to create a link between records.

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

SystemObject
  Microsoft.Xrm.SdkOrganizationRequest
    Microsoft.Xrm.Sdk.MessagesAssociateRequest

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodAssociateRequest

Initializes a new instance of the AssociateRequest class.

NameDescription
System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the collection of entity references (references to records) to be associated. Required.

System_CAPS_pubproperty

Get or sets the relationship name to be used for an association. Required.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the target that is the record to which the related records are associated. Required.

NameDescription
System_CAPS_pubmethodEquals

(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 the AssociateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified records in the and properties. For a list of the required privileges, see Associate message privileges.

Notes for Callers

This message uses a single transaction to create multiple associations between the record that is specified by the Id in the property and each record in the property. The associations are created for the specified relationship in the property.

You can also use the Associate method to perform the same action.

For a one-to-many relationship, this message sets the property in the related record to the value of the Id in the .

For a many-to-many relationship, this message creates a record in the intersect table for the relationship, which contains the ID of both the referenced and referencing records. The intersect table name is defined in the property for the relationship. You need this when you query for the records. However, you need the relationship name to set the property. This name is defined in the property for the relationship.

Supported Entities

You can use this message to associate records of any two entities (includes records for custom entities) that participate in a relationship. To find a list of the default relationships, see the Entity Metadata topic for each entity.

The following sample shows how to execute the AssociateRequest message.

No code example is currently available or this language may not be supported.

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: