RetrieveAllEntitiesRequest RetrieveAllEntitiesRequest RetrieveAllEntitiesRequest RetrieveAllEntitiesRequest Class

Definition

Contains the data that is needed to retrieve metadata information about all the entities.

For the Web API use the RetrieveAllEntities Function.

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

// Use the RetrieveAttributeRequest message to retrieve  
// a attribute by it's logical name.
RetrieveAttributeRequest retrieveAttributeRequest =
    new RetrieveAttributeRequest
{
    EntityLogicalName = Contact.EntityLogicalName,
    LogicalName = "new_picklist",
    RetrieveAsIfPublished = true
};

// Execute the request. RetrieveAttributeResponse retrieveAttributeResponse = (RetrieveAttributeResponse)svc.Execute(retrieveAttributeRequest);

// Access the retrieved attribute. PicklistAttributeMetadata retrievedPicklistAttributeMetadata = (PicklistAttributeMetadata) retrieveAttributeResponse.AttributeMetadata;

// Get the current options list for the retrieved attribute. OptionMetadata[] optionList = retrievedPicklistAttributeMetadata.OptionSet.Options.ToArray();

// Change the order of the original option's list. // Use the OrderBy (OrderByDescending) linq function to sort options in
// ascending (descending) order according to label text. // For ascending order use this: var updateOptionList = optionList.OrderBy(x => x.Label.LocalizedLabels[0].Label).ToList();

// For descending order use this: var updateOptionList =optionList.OrderByDescending(x => x.Label.LocalizedLabels[0].Label).ToList();

// Create the request. OrderOptionRequest orderOptionRequest = new OrderOptionRequest { // Set the properties for the request. AttributeLogicalName = "new_picklist", EntityLogicalName = Contact.EntityLogicalName, // Set the changed order using Select linq function // to get only values in an array from the changed option list. Values = updateOptionList.Select(x => x.Value.Value).ToArray() };

// Execute the request svc.Execute(orderOptionRequest); Console.WriteLine("Option Set option order changed");

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.

entities#DumpEntityInfo1 entitiesVB#DumpEntityInfo1

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 RetrieveAllEntitiesResponse.

Privileges and Access Rights

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

Notes for Callers

This request returns a large amount of data and may take significant time to return all the data. When there are a large number of customizations it is possible that this request could fail due to time limitations using Microsoft Dynamics 365 (online).

Use the RetrieveMetadataChangesRequest to request just the metadata you need. Otherwise, use EntityFilters.Entity as the EntityFilters parameter to minimize the amount of data retrieved. Then, using the LogicalName returned for each entity, use the RetrieveEntityRequest class to for each entity that you need metadata for. Splitting up the requests can reduce the chance that your request will time out.

Constructors

RetrieveAllEntitiesRequest() RetrieveAllEntitiesRequest() RetrieveAllEntitiesRequest() RetrieveAllEntitiesRequest()

Initializes a new instance of the RetrieveAllEntitiesRequest class

Properties

EntityFilters EntityFilters EntityFilters EntityFilters

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

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RetrieveAsIfPublished RetrieveAsIfPublished RetrieveAsIfPublished RetrieveAsIfPublished

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

Applies to