DisassociateRequest Class

  • Article

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

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

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

Syntax

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

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

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 DisassociateResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the entity specified in the entityName parameter and access rights on the records specified in the entityId and relatedEntities parameters. For a list of the privileges required, see Disassociate Privileges.

Notes for Callers

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

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

For a many-to-many relationship, this method deletes a record in the intersect table for the relationship. 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 method to disassociate any records that participate in a relationship, including records for custom entities. You can find the default relationships listed in the Entity Metadata topic for each entity.

Inheritance Hierarchy

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

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

DisassociateRequest Members
Microsoft.Xrm.Sdk.Messages Namespace
DisassociateResponse
IOrganizationService.Disassociate Method
Entity Metadata

Other Resources

Entity Relationship Behavior
Customize Entity Relationship Metadata

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