RetrieveAllEntitiesRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the RetrieveAllEntities Function.

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

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveAllEntitiesRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class RetrieveAllEntitiesRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	RetrieveAllEntitiesRequest()	Initializes a new instance of the RetrieveAllEntitiesRequest class

Properties

	Name	Description
	EntityFilters	Gets or sets a filter to control how much data for each 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.)
	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

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

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


              RetrieveAllEntitiesRequest request = new RetrieveAllEntitiesRequest()
              {
                  EntityFilters = EntityFilters.Entity,
                  RetrieveAsIfPublished = true
              };

              // Retrieve the MetaData.
              RetrieveAllEntitiesResponse response = (RetrieveAllEntitiesResponse)_serviceProxy.Execute(request);


              // Create an instance of StreamWriter to write text to a file.
              // The using statement also closes the StreamWriter.
// To view this file, right click the file and choose open with Excel. 
// Excel will figure out the schema and display the information in columns.

              String filename = String.Concat("EntityInfo.xml");
              using (StreamWriter sw = new StreamWriter(filename))
              {
                  // Create Xml Writer.
                  XmlTextWriter metadataWriter = new XmlTextWriter(sw);

                  // Start Xml File.
                  metadataWriter.WriteStartDocument();

                  // Metadata Xml Node.
                  metadataWriter.WriteStartElement("Metadata");

                  foreach (EntityMetadata currentEntity in response.EntityMetadata)
                  {
                      //if (currentEntity.IsIntersect.Value == false)
                      if (true)
                      {
                          // Start Entity Node
                          metadataWriter.WriteStartElement("Entity");

                          // Write the Entity's Information.
                          metadataWriter.WriteElementString("EntitySchemaName", currentEntity.SchemaName);
                          metadataWriter.WriteElementString("OTC", currentEntity.ObjectTypeCode.ToString());
                          metadataWriter.WriteElementString("OwnershipType", currentEntity.OwnershipType.Value.ToString());
                          if (currentEntity.DisplayName.UserLocalizedLabel != null)
                              metadataWriter.WriteElementString("DisplayName", currentEntity.DisplayName.UserLocalizedLabel.Label);
                          if (currentEntity.DisplayCollectionName.UserLocalizedLabel != null)
                              metadataWriter.WriteElementString("DisplayCollectionName", currentEntity.DisplayCollectionName.UserLocalizedLabel.Label);
                          metadataWriter.WriteElementString("IntroducedVersion", currentEntity.IntroducedVersion.ToString());
                          metadataWriter.WriteElementString("AutoRouteToOwnerQueue", currentEntity.AutoRouteToOwnerQueue.ToString());
                          metadataWriter.WriteElementString("CanBeInManyToMany", currentEntity.CanBeInManyToMany.Value.ToString());
                          metadataWriter.WriteElementString("CanBePrimaryEntityInRelationship", currentEntity.CanBePrimaryEntityInRelationship.Value.ToString());
                          metadataWriter.WriteElementString("CanBeRelatedEntityInRelationship", currentEntity.CanBeRelatedEntityInRelationship.Value.ToString());
                          metadataWriter.WriteElementString("CanCreateAttributes", currentEntity.CanCreateAttributes.Value.ToString());
                          metadataWriter.WriteElementString("CanCreateCharts", currentEntity.CanCreateCharts.Value.ToString());
                          metadataWriter.WriteElementString("CanCreateForms", currentEntity.CanCreateForms.Value.ToString());
                          metadataWriter.WriteElementString("CanCreateViews", currentEntity.CanCreateViews.Value.ToString());
                          metadataWriter.WriteElementString("CanModifyAdditionalSettings", currentEntity.CanModifyAdditionalSettings.Value.ToString());
                          metadataWriter.WriteElementString("CanTriggerWorkflow", currentEntity.CanTriggerWorkflow.Value.ToString());

                          metadataWriter.WriteElementString("IsActivity", currentEntity.IsActivity.Value.ToString());
                          //metadataWriter.WriteElementString("ActivityTypeMask", currentEntity.ActivityTypeMask.ToString());

                          metadataWriter.WriteElementString("IsActivityParty", currentEntity.IsActivityParty.Value.ToString());

                          metadataWriter.WriteElementString("IsAuditEnabled", currentEntity.IsAuditEnabled.Value.ToString());
                          metadataWriter.WriteElementString("IsAvailableOffline", currentEntity.IsAvailableOffline.ToString());
                          metadataWriter.WriteElementString("IsChildEntity", currentEntity.IsChildEntity.ToString());
                          metadataWriter.WriteElementString("IsConnectionsEnabled", currentEntity.IsConnectionsEnabled.ManagedPropertyLogicalName.ToString());
                          metadataWriter.WriteElementString("IsCustomEntity", currentEntity.IsCustomEntity.Value.ToString());
                          metadataWriter.WriteElementString("IsCustomizable", currentEntity.IsCustomizable.Value.ToString());

                          metadataWriter.WriteElementString("IsDocumentManagementEnabled", currentEntity.IsDocumentManagementEnabled.Value.ToString());
                          metadataWriter.WriteElementString("IsDuplicateDetectionEnabled", currentEntity.IsDuplicateDetectionEnabled.Value.ToString());
                          if (currentEntity.IsEnabledForCharts != null)
                              metadataWriter.WriteElementString("IsEnabledForCharts", currentEntity.IsEnabledForCharts.Value.ToString());
                          metadataWriter.WriteElementString("IsImportable", currentEntity.IsImportable.Value.ToString());
                          metadataWriter.WriteElementString("IsIntersect", currentEntity.IsIntersect.Value.ToString());

                          metadataWriter.WriteElementString("IsMailMergeEnabled", currentEntity.IsMailMergeEnabled.Value.ToString());
                          metadataWriter.WriteElementString("IsManaged", currentEntity.IsManaged.Value.ToString());
                          metadataWriter.WriteElementString("IsMappable", currentEntity.IsMappable.Value.ToString());

                          metadataWriter.WriteElementString("IsReadingPaneEnabled", currentEntity.IsReadingPaneEnabled.Value.ToString());
                          metadataWriter.WriteElementString("IsRenameable", currentEntity.IsRenameable.Value.ToString()); 
                          metadataWriter.WriteElementString("IsValidForAdvancedFind", currentEntity.IsValidForAdvancedFind.Value.ToString());
                          metadataWriter.WriteElementString("IsValidForQueue", currentEntity.IsValidForQueue.Value.ToString());
                          metadataWriter.WriteElementString("IsVisibleInMobile", currentEntity.IsVisibleInMobile.Value.ToString());

                          metadataWriter.WriteElementString("PrimaryIdAttribute", currentEntity.PrimaryIdAttribute);
                          metadataWriter.WriteElementString("PrimaryNameAttribute", currentEntity.PrimaryNameAttribute);
                          metadataWriter.WriteElementString("ReportViewName", currentEntity.ReportViewName);
                          metadataWriter.WriteElementString("RecurrenceBaseEntityLogicalName", currentEntity.RecurrenceBaseEntityLogicalName);
                          if (currentEntity.Description.UserLocalizedLabel != null)
                              metadataWriter.WriteElementString("Description", currentEntity.Description.UserLocalizedLabel.Label);



                          // End Entity Node
                          metadataWriter.WriteEndElement();
                      }
                  }

                  // End Metadata Xml Node
                  metadataWriter.WriteEndElement();
                  metadataWriter.WriteEndDocument();

                  // Close xml writer.
                  metadataWriter.Close();
              }




             Console.WriteLine("Done.");


Dim request As New RetrieveAllEntitiesRequest() With {
 .EntityFilters = EntityFilters.Entity,
 .RetrieveAsIfPublished = True
}

' Retrieve the MetaData.
Dim response As RetrieveAllEntitiesResponse = CType(_serviceProxy.Execute(request), RetrieveAllEntitiesResponse)


' Create an instance of StreamWriter to write text to a file.
' The using statement also closes the StreamWriter.
' To view this file, right click the file and choose open with Excel. 
' Excel will figure out the schema and display the information in columns.

Dim filename As String = String.Concat("EntityInfo.xml")
Using sw As New StreamWriter(filename)
 ' Create Xml Writer.
 Dim metadataWriter As New XmlTextWriter(sw)

 ' Start Xml File.
 metadataWriter.WriteStartDocument()

 ' Metadata Xml Node.
 metadataWriter.WriteStartElement("Metadata")

 For Each currentEntity As EntityMetadata In response.EntityMetadata
  'if (currentEntity.IsIntersect.Value == false)
  If True Then
   ' Start Entity Node
   metadataWriter.WriteStartElement("Entity")

   ' Write the Entity's Information.
   metadataWriter.WriteElementString("EntityLogicalName", currentEntity.LogicalName)
   metadataWriter.WriteElementString("OTC", currentEntity.ObjectTypeCode.ToString())
   metadataWriter.WriteElementString("OwnershipType", currentEntity.OwnershipType.Value.ToString())
   If currentEntity.DisplayName.UserLocalizedLabel IsNot Nothing Then
    metadataWriter.WriteElementString("DisplayName", currentEntity.DisplayName.UserLocalizedLabel.Label)
   End If
   If currentEntity.DisplayCollectionName.UserLocalizedLabel IsNot Nothing Then
    metadataWriter.WriteElementString("DisplayCollectionName", currentEntity.DisplayCollectionName.UserLocalizedLabel.Label)
   End If

   metadataWriter.WriteElementString("AutoRouteToOwnerQueue", currentEntity.AutoRouteToOwnerQueue.ToString())
   metadataWriter.WriteElementString("CanBeInManyToMany", currentEntity.CanBeInManyToMany.Value.ToString())
   metadataWriter.WriteElementString("CanBePrimaryEntityInRelationship", currentEntity.CanBePrimaryEntityInRelationship.Value.ToString())
   metadataWriter.WriteElementString("CanBeRelatedEntityInRelationship", currentEntity.CanBeRelatedEntityInRelationship.Value.ToString())
   metadataWriter.WriteElementString("CanCreateAttributes", currentEntity.CanCreateAttributes.Value.ToString())
   metadataWriter.WriteElementString("CanCreateCharts", currentEntity.CanCreateCharts.Value.ToString())
   metadataWriter.WriteElementString("CanCreateForms", currentEntity.CanCreateForms.Value.ToString())
   metadataWriter.WriteElementString("CanCreateViews", currentEntity.CanCreateViews.Value.ToString())
   metadataWriter.WriteElementString("CanModifyAdditionalSettings", currentEntity.CanModifyAdditionalSettings.Value.ToString())
   metadataWriter.WriteElementString("CanTriggerWorkflow", currentEntity.CanTriggerWorkflow.Value.ToString())

   metadataWriter.WriteElementString("IsActivity", currentEntity.IsActivity.Value.ToString())
   'metadataWriter.WriteElementString("ActivityTypeMask", currentEntity.ActivityTypeMask.ToString());

   metadataWriter.WriteElementString("IsActivityParty", currentEntity.IsActivityParty.Value.ToString())

   metadataWriter.WriteElementString("IsAuditEnabled", currentEntity.IsAuditEnabled.Value.ToString())
   metadataWriter.WriteElementString("IsAvailableOffline", currentEntity.IsAvailableOffline.ToString())
   metadataWriter.WriteElementString("IsChildEntity", currentEntity.IsChildEntity.ToString())
   metadataWriter.WriteElementString("IsConnectionsEnabled", currentEntity.IsConnectionsEnabled.ManagedPropertyLogicalName.ToString())
   metadataWriter.WriteElementString("IsCustomEntity", currentEntity.IsCustomEntity.Value.ToString())
   metadataWriter.WriteElementString("IsCustomizable", currentEntity.IsCustomizable.Value.ToString())

   metadataWriter.WriteElementString("IsDocumentManagementEnabled", currentEntity.IsDocumentManagementEnabled.Value.ToString())
   metadataWriter.WriteElementString("IsDuplicateDetectionEnabled", currentEntity.IsDuplicateDetectionEnabled.Value.ToString())
   If currentEntity.IsEnabledForCharts IsNot Nothing Then
    metadataWriter.WriteElementString("IsEnabledForCharts", currentEntity.IsEnabledForCharts.Value.ToString())
   End If
   metadataWriter.WriteElementString("IsImportable", currentEntity.IsImportable.Value.ToString())
   metadataWriter.WriteElementString("IsIntersect", currentEntity.IsIntersect.Value.ToString())

   metadataWriter.WriteElementString("IsMailMergeEnabled", currentEntity.IsMailMergeEnabled.Value.ToString())
   metadataWriter.WriteElementString("IsManaged", currentEntity.IsManaged.Value.ToString())
   metadataWriter.WriteElementString("IsMappable", currentEntity.IsMappable.Value.ToString())

   metadataWriter.WriteElementString("IsReadingPaneEnabled", currentEntity.IsReadingPaneEnabled.Value.ToString())
   metadataWriter.WriteElementString("IsRenameable", currentEntity.IsRenameable.Value.ToString())
   metadataWriter.WriteElementString("IsValidForAdvancedFind", currentEntity.IsValidForAdvancedFind.Value.ToString())
   metadataWriter.WriteElementString("IsValidForQueue", currentEntity.IsValidForQueue.Value.ToString())
   metadataWriter.WriteElementString("IsVisibleInMobile", currentEntity.IsVisibleInMobile.Value.ToString())

   metadataWriter.WriteElementString("PrimaryIdAttribute", currentEntity.PrimaryIdAttribute)
   metadataWriter.WriteElementString("PrimaryNameAttribute", currentEntity.PrimaryNameAttribute)
   metadataWriter.WriteElementString("ReportViewName", currentEntity.ReportViewName)
   metadataWriter.WriteElementString("RecurrenceBaseEntityLogicalName", currentEntity.RecurrenceBaseEntityLogicalName)
   If currentEntity.Description.UserLocalizedLabel IsNot Nothing Then
    metadataWriter.WriteElementString("Description", currentEntity.Description.UserLocalizedLabel.Label)
   End If



   ' End Entity Node
   metadataWriter.WriteEndElement()
  End If
 Next currentEntity

 ' End Metadata Xml Node
 metadataWriter.WriteEndElement()
 metadataWriter.WriteEndDocument()

 ' Close xml writer.
 metadataWriter.Close()
End Using




Console.WriteLine("Done.")

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.

Share via