DeleteEntityRequest Class

  • Reference

Definition

Namespace:
Microsoft.Xrm.Sdk.Messages
Assembly:
Microsoft.Xrm.Sdk.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Contains the data that is needed to delete a table. 

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

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
/// </summary>
/// <param name="service">Authenticated IOrganizationService instance</param>
static void DeleteTableExample(IOrganizationService service) {

   string tableLogicalName = "sample_bankaccount";

    DeleteEntityRequest request = new()
    {
        LogicalName = tableLogicalName
    };

    service.Execute(request);
}

Sample code on GitHub

Create and update table definitions

Remarks

Usage

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

Privileges and Access Rights

To perform this action, the user must have the System Administrator or System Customizer security role.

Constructors

DeleteEntityRequest()

Initializes a new instance of the DeleteEntityRequest 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)
LogicalName

Gets or sets the logical name of the table. 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

See also