IOrganizationService.Associate Method

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Creates a link between records.

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

Syntax

'Declaration
<OperationContractAttribute> _
<FaultContractAttribute(GetType(OrganizationServiceFault))> _
Sub Associate ( _
    entityName As String, _
    entityId As Guid, _
    relationship As Relationship, _
    relatedEntities As EntityReferenceCollection _
)

[OperationContractAttribute] 
[FaultContractAttribute(typeof(OrganizationServiceFault))] 
void Associate (
    string entityName,
    Guid entityId,
    Relationship relationship,
    EntityReferenceCollection relatedEntities
)

Parameters

  • entityName
    Type: String. The logical name of the entity that is specified in the entityId parameter.
  • entityId
    Type: Guid. The ID of the record to which the related records are associated.
  • relationship
    Type: Relationship. The name of the relationship to be used to create the link.
  • relatedEntities
    Type: EntityReferenceCollection. A collection of entity references (references to records) to be associated.

Example

The following example shows how to use the Associate method to create an association or link between records. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\AssociateDisassociateDE.cs.

Remarks

Message Availability

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the entity that is specified in the entityName parameter and access rights on the record that is specified in the entityId parameter. For a list of the required privileges, see Associate Privileges.

Notes for Callers

This method creates multiple associations in one transaction between the record that is specified by the entityId parameter and each record in the relatedEntities parameter for the specified relationship in the relationship parameter.

For a one-to-many relationship, this method sets the ReferencingAttribute in the related record to the value of the entityId.

For a many-to-many relationship, this method 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.

For more information about the exceptions that can be thrown when this method is called, see Handle Exceptions in Your Code.

Supported Entities

You can use this method to associate any records that participate in a relationship, including records for custom entities.

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.

Platforms

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

See Also

Reference

IOrganizationService Interface
IOrganizationService Members
Microsoft.Xrm.Sdk Namespace
Entity Metadata
AssociateRequest
AssociateResponse
Assign

Other Resources

Customize Entity Relationship Metadata
Sample: Associate (Early Bound)
Handle Exceptions in Your Code
Troubleshooting and Error Handling

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