AssociateRequest Class

Artikel
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.AssociateRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class AssociateRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")]
public ref class AssociateRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")>]
type AssociateRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class AssociateRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	AssociateRequest()	Initializes a new instance of the AssociateRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RelatedEntities	Gets or sets the collection of entity references (references to records) to be associated. Required.
	Relationship	Get or sets the relationship name to be used for an association. Required.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Target	Gets or sets the target that is the record to which the related records are associated. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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 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 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.

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


' 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.
_serviceProxy.Execute(teamToProfile)

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.

Dela via