RetrieveAllEntitiesRequest クラス
適用対象: CRM 2015 on-prem, CRM Online
Contains the data that is needed to retrieve metadata information about all the entities.
名前空間: Microsoft.Xrm.Sdk.Messages
アセンブリ: Microsoft.Xrm.Sdk (Microsoft.Xrm.Sdk.dll に含まれる)
構文
'宣言
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/xrm/2011/Contracts")> _
Public NotInheritable Class RetrieveAllEntitiesRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveAllEntitiesRequest : OrganizationRequest
例
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("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.");
備考
Message Availability
このメッセージは、呼び出し元がサーバーに接続されているか、オフラインであるかに関係なく機能します。
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 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 CRM 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.
継承階層
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.RetrieveAllEntitiesRequest
スレッド セーフ
この種類のパブリックな静的 (Visual Basic では Shared) メンバーはスレッド セーフです。インスタンス メンバーがスレッド セーフであることは保証されません。
プラットフォーム
開発プラットフォーム
Windows Vista、Windows Server 2003、および
対象プラットフォーム
Windows Vista、Windows XP
Change History
関連項目
参照
RetrieveAllEntitiesRequest のメンバー
Microsoft.Xrm.Sdk.Messages 名前空間
他のリソース
Sample: Dump Entity Metadata to a File
Sample: Dump Entity Relationship Information to a File
Sample: Dump Entity Privilege Information to a File
Query and Capture Changes to Metadata
Customize Entity Metadata
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.