DeleteEntityKeyRequest 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 the specified key for an entity.

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

DeleteEntityKeyRequest()

Initializes a new instance of the DeleteEntityKeyRequest class.

Properties

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

Share via