DeleteAttributeRequest DeleteAttributeRequest DeleteAttributeRequest DeleteAttributeRequest Class

Definition

Contains the data that is needed to delete an attribute.

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
type DeleteAttributeRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DeleteAttributeRequest
Inherits OrganizationRequest
Inheritance
DeleteAttributeRequestDeleteAttributeRequestDeleteAttributeRequestDeleteAttributeRequest
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.

// Delete all attributes created for this sample.
foreach (AttributeMetadata anAttribute in addedAttributes)
{
    // Create the request object
    DeleteAttributeRequest deleteAttribute = new DeleteAttributeRequest
    {
        // Set the request properties 
        EntityLogicalName = Contact.EntityLogicalName,
        LogicalName = anAttribute.SchemaName
    };
    
    // Execute the request
    svc.Execute(deleteAttribute);
}

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(OrganizationRequest) method, which returns an instance of DeleteAttributeResponse.

Privileges and Access Rights

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

Notes for Callers

Constructors

DeleteAttributeRequest() DeleteAttributeRequest() DeleteAttributeRequest() DeleteAttributeRequest()

Initializes a new instance of the DeleteAttributeRequest class

Properties

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

Gets or sets the logical name of the entity that contains the attribute. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
LogicalName LogicalName LogicalName LogicalName

Gets or sets the logical name of the attribute to delete. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to