AssociateRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft 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)


<DataContractAttribute(Namespace:="")> _
Public NotInheritable Class AssociateRequest
    Inherits OrganizationRequest
public sealed class AssociateRequest : OrganizationRequest


The following sample shows how to execute the AssociateRequest message.

// Create the request object and set the monikers with the
// teamprofiles_association relationship.
AssociateRequest teamToProfile = new AssociateRequest
    Target = new EntityReference(FieldSecurityProfile.EntityLogicalName, _profileId),
    RelatedEntities = new EntityReferenceCollection
        new EntityReference(Team.EntityLogicalName, _teamId)
    Relationship = new Relationship("teamprofiles_association")

// Execute the request.
' Create the request object and set the monikers with the
' teamprofiles_association relationship.
Dim teamToProfile As AssociateRequest = New AssociateRequest With { _
    .Target = New EntityReference(FieldSecurityProfile.EntityLogicalName, _profileId), _
    .RelatedEntities = New EntityReferenceCollection From {New EntityReference(Team.EntityLogicalName, _teamId)}, _
    .Relationship = New Relationship("teamprofiles_association")}

' Execute the request.


Message Availability

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


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 Target property and access rights on the specified records in the Target and RelatedEntities properties. For a list of the required privileges, see Associate 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 Target property and each record in the RelatedEntities property. The associations are created for the specified relationship in the Relationship property.

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

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

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 IntersectEntityName property for the relationship. You need this when you query for the records. However, you need the relationship name to set the Relationship property. This name is defined in the SchemaName 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.

Inheritance Hierarchy


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.


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

Change History

See Also


AssociateRequest Members
Microsoft.Xrm.Sdk.Messages Namespace
Entity Metadata
IOrganizationService.Associate Method

Other Resources

Entity Relationship Behavior
Customize Entity Relationship Metadata
Sample: Retrieve Field Permissions
Associate Privileges

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.