RetrieveEntityKeyRequest Class

Definition

Contains data that is needed to retrieve an alternate key.

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

Remarks

This message takes the entity name and key name as input values to retrieve the specified key for the entity.

Usage

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

Notes for Callers

You have to specify the EntityLogicalName and the LogicalName to specify the key you want to retrieve.

Constructors

RetrieveEntityKeyRequest()

Initializes a new instance of the RetrieveEntityKeyRequest class.

Properties

EntityLogicalName

Gets or sets the entity name.

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 key name.

MetadataId

Gets or sets the metadata ID.

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)
RetrieveAsIfPublished

Gets or sets whether to retrieve the metadata that has not been published. Required.

Applies to