RetrieveEntityRequest Class
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to retrieve entity metadata.
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.RetrieveEntityRequest
| Name | Description | |
|---|---|---|
![]() | RetrieveEntityRequest() | Initializes a new instance of the RetrieveEntityRequest class. |
| Name | Description | |
|---|---|---|
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | (Inherited from Object.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetType() | (Inherited from Object.) |
![]() | ToString() | (Inherited from Object.) |
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 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.
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.
RetrieveEntityRequest retrieveBankAccountEntityRequest = new RetrieveEntityRequest
{
EntityFilters = EntityFilters.Entity,
LogicalName = _customEntityName
};
RetrieveEntityResponse retrieveBankAccountEntityResponse = (RetrieveEntityResponse)_serviceProxy.Execute(retrieveBankAccountEntityRequest);
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright

