Share via

DeleteRelationshipRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft 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)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/xrm/2011/Contracts")> _
Public NotInheritable Class DeleteRelationshipRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/xrm/2011/Contracts")] 
public sealed class DeleteRelationshipRequest : OrganizationRequest

Example

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.")

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 Privileges.

Notes for Callers

Inheritance Hierarchy

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

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

DeleteRelationshipRequest Members
Microsoft.Xrm.Sdk.Messages Namespace

Other Resources

Sample: Create and Retrieve Entity Relationships
Customize Entity Relationship Metadata

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.