RemoveRelatedRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Use the DisassociateRequestclass. Contains the data that is needed to remove the relationship between the specified records for specific relationships.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RemoveRelatedRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RemoveRelatedRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RemoveRelatedRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RemoveRelatedRequest() | Initializes a new instance of the RemoveRelatedRequest 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.) |
|
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 records from which you want to remove specific related records. |
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 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 entities and relationships that support this message.
Entity |
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 |
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.
See Also
DisassociateRequest
RemoveRelatedResponse
Microsoft.Crm.Sdk.Messages Namespace
Actions on entity records
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright