RetrieveEntityKeyRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains data that is needed to retrieve an alternate key.
Namespace: Microsoft.Xrm.Sdk.Messages
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.RetrieveEntityKeyRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveEntityKeyRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class RetrieveEntityKeyRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RetrieveEntityKeyRequest() | Initializes a new instance of the RetrieveEntityKeyRequest class. |
Properties
Name | Description | |
---|---|---|
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 an asynchronous operation (system job). 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. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 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.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Microsoft.Xrm.Sdk.Messages Namespace
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright