DeleteEntityKeyRequest Class

Definition

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

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

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

Public NotInheritable Class DeleteEntityKeyRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

DeleteEntityKeyRequest

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 an entity key
/// </summary>
/// <param name="service">Authenticated IOrganizationService instance</param>
static void DeleteEntityKeyExample(IOrganizationService service) {
    string tableLogicalName = "sample_bankaccount";
    string keyUniqueName = "sample_UniqueName";

    DeleteEntityKeyRequest request = new() { 
          EntityLogicalName = tableLogicalName,
          Name = keyUniqueName
    };

    service.Execute(request);
}

Remarks

This message takes the entity name and key name as input to delete the key.

Usage

When you pass an instance of this class to the Execute(OrganizationRequest) method, it returns an instance of the DeleteEntityKeyResponseclass.

Constructors

Properties

Applies to