DisassociateRequest Class

Definition

public ref class DisassociateRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class DisassociateRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type DisassociateRequest = class
    inherit OrganizationRequest

Public NotInheritable Class DisassociateRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

DisassociateRequest

Attributes

DataContractAttribute

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 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 Delete message 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.

Constructors

Properties

Applies to

See also

• DisassociateResponse
• Disassociate(String, Guid, Relationship, EntityReferenceCollection)