AssociateRequest AssociateRequest AssociateRequest AssociateRequest Class

Definition

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

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

Examples

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. svc.Execute(teamToProfile);

The following sample shows how to execute the AssociateRequest message.

FieldSecurity#EnableFieldSecurityForAnEntity2 FieldSecurityVB#EnableFieldSecurityForAnEntity2

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 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 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 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(String, Guid, Relationship, EntityReferenceCollection) 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.

Constructors

AssociateRequest() AssociateRequest() AssociateRequest() AssociateRequest()

Initializes a new instance of the AssociateRequest 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)
RelatedEntities RelatedEntities RelatedEntities RelatedEntities

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

Relationship Relationship Relationship Relationship

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

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 that is the record to which the related records are associated. Required.

Applies to

See also