DeleteRelationshipRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to delete an entity relationship.

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

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class DeleteRelationshipRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class DeleteRelationshipRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod DeleteRelationshipRequest()

Initializes a new instance of the DeleteRelationshipRequest class

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Name

Gets or sets the name of the relationship to delete. Required.

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of DeleteRelationshipResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges listed in DeleteRelationship message privileges.

Notes for Callers

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


DeleteRelationshipRequest deleteOneToManyRelationshipRequest = 
    new DeleteRelationshipRequest
{                    
    Name = "new_account_campaign"
};

_serviceProxy.Execute(deleteOneToManyRelationshipRequest);

DeleteRelationshipRequest deleteManyToManyRelationshipRequest = 
    new DeleteRelationshipRequest
{
    Name = "new_accounts_campaigns"
};

_serviceProxy.Execute(deleteManyToManyRelationshipRequest);

Console.WriteLine("Entity Relationships have been deleted.");

Dim deleteOneToManyRelationshipRequest As DeleteRelationshipRequest =
 New DeleteRelationshipRequest With {
  .Name = "new_account_campaign"
 }

_serviceProxy.Execute(deleteOneToManyRelationshipRequest)

Dim deleteManyToManyRelationshipRequest As DeleteRelationshipRequest =
 New DeleteRelationshipRequest With {
  .Name = "new_accounts_campaigns"
 }

_serviceProxy.Execute(deleteManyToManyRelationshipRequest)

Console.WriteLine("Entity Relationships have been deleted.")

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

Microsoft.Xrm.Sdk.Messages Namespace
Sample: Create and retrieve entity relationships
Customize entity relationship metadata

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright