RemoveRelatedRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Use the DisassociateRequestclass. Contains the data that is needed to remove the relationship between the specified records for specific relationships.

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

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

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

Public NotInheritable Class RemoveRelatedRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RemoveRelatedRequest

Attributes: DataContractAttribute

Remarks

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the RemoveRelatedResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges and access rights on the records that are specified in the Target property. For a complete list of the required privileges, see RemoveRelated message privileges.

Notes for Callers

This message works for a limited set of relationships and will be deprecatedin a future version. Instead, use DisassociateRequest.

Supported Relationships

The following table shows the tables and relationships that support this message.

Table	Relationship Schema Name
Invoice	contactinvoices_association
Lead	accountleads_association contactleads_association
Opportunity	opportunity_customer_accounts opportunitycompetitors_association opportunity_customer_contacts
Product	competitorproduct_association leadproduct_association
Quote	contactquotes_association
SalesLiterature	competitorsalesliterature_association productsalesliterature_association
SalesOrder	contactorders_association

Table

Relationship Schema Name

Invoice

contactinvoices_association

Lead

accountleads_association

contactleads_association

Opportunity

opportunity_customer_accounts

opportunitycompetitors_association

opportunity_customer_contacts

Product

competitorproduct_association

leadproduct_association

Quote

contactquotes_association

SalesLiterature

competitorsalesliterature_association

productsalesliterature_association

SalesOrder

contactorders_association

Constructors

RemoveRelatedRequest()

Initializes a new instance of the RemoveRelatedRequest class.

Properties

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)
RequestId	Gets or sets the ID of the request. 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 records from which you want to remove specific related records.

Applies to

Jaa