DeleteAttributeRequest Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Messages

Assembly:: Microsoft.Xrm.Sdk.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the data that is needed to delete a column.

public ref class DeleteAttributeRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class DeleteAttributeRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type DeleteAttributeRequest = class
    inherit OrganizationRequest

Public NotInheritable Class DeleteAttributeRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
DeleteAttributeRequest

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 column
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
static void DeleteColumnExample(IOrganizationService service) {

    string tableLogicalName = "sample_bankaccount";
    string columnLogicalName = "sample_example";

    DeleteAttributeRequest request = new() { 
        EntityLogicalName = tableLogicalName,
        LogicalName = columnLogicalName
    };

    service.Execute(request);        
}

Sample code on GitHub

Work with attribute metadata

Remarks

Usage

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

Privileges and Access Rights

To perform this action, the caller must have the prvDeleteAttribute privileges that are granted to the System Administrator and System Customizer security roles.

Notes for Callers

Constructors

DeleteAttributeRequest()

Initializes a new instance of the DeleteAttributeRequest class

Properties

EntityLogicalName	Gets or sets the logical name of the table that contains the column. Required.
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 column 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

Dela via