DisassociateRequest DisassociateRequest DisassociateRequest DisassociateRequest Class

Definition

Namespace:
Microsoft.Xrm.Sdk.Messages Microsoft.Xrm.Sdk.Messages Microsoft.Xrm.Sdk.Messages Microsoft.Xrm.Sdk.Messages
Assembly:
Microsoft.Xrm.Sdk.dll

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

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
type DisassociateRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DisassociateRequest
Inherits OrganizationRequest
Inheritance
ObjectObjectObjectObject
OrganizationRequestOrganizationRequestOrganizationRequestOrganizationRequest
DisassociateRequestDisassociateRequestDisassociateRequestDisassociateRequest
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

DisassociateRequest() DisassociateRequest() DisassociateRequest() DisassociateRequest()

Initializes a new instance of the DisassociateRequest 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 disassociated. Required.
Relationship Relationship Relationship Relationship

Get or sets the name of the relationship to be used for the disassociation. 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, which is the record from which the related records will be disassociated. Required.

Applies to

See also