RetrieveEntityRequest Class

Definition

Contains the data that is needed to retrieve entity metadata.

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

// Create the request
RetrieveEntityRequest entityRequest = new RetrieveEntityRequest
{
    LogicalName = Account.EntityLogicalName
};

// Execute the request
RetrieveEntityResponse entityResponse =
    (RetrieveEntityResponse)svc.Execute(entityRequest);
Console.WriteLine("Retrieved the entity {0}.",
    entityResponse.EntityMetadata.SchemaName);

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. For the complete sample, see the link later in this topic.

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

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

Privileges and Access Rights

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

Notes for Callers

You can use either the LogicalName or the MetadataId to specify the entity you want to retrieve.

Constructors

RetrieveEntityRequest()

Initializes a new instance of the RetrieveEntityRequest class.

Properties

EntityFilters

Gets or sets a filter to control how much data for the entity is retrieved. Required.

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 logical name of the entity to be retrieved. Optional.

MetadataId

A unique identifier for the entity. Optional.

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.

Applies to