Partilhar via


DeleteRelationshipRequest Class

Definition

Contains the data that is needed to delete a table relationship.

public ref class DeleteRelationshipRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class DeleteRelationshipRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type DeleteRelationshipRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DeleteRelationshipRequest
Inherits OrganizationRequest
Inheritance
DeleteRelationshipRequest
Attributes

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

/// <summary>
/// Demonstrates how to delete a table relationship
/// </summary>
/// <param name="service">Authenticated IOrganizationService instance</param>
static void DeleteRelationship(IOrganizationService service) {

    string relationshipName = "sample_Account_Contact_Contact";

    DeleteRelationshipRequest request = new() { 
          Name = relationshipName
    };

    service.Execute(request);        
}

Sample code on GitHub

Create and retrieve table relationships

Remarks

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges included in the System Administrator or System Customizer security roles.

Constructors

DeleteRelationshipRequest()

Initializes a new instance of the DeleteRelationshipRequest 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)
Name

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

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)

Applies to