EntityFilters Enumeration

 

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

Describes the type of entity metadata to retrieve.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:   Microsoft.Xrm.Sdk.Metadata
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

[FlagsAttribute]
[DataContractAttribute(Name = "EntityFilters", Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata")]
public enum EntityFilters
<FlagsAttribute>
<DataContractAttribute(Name := "EntityFilters", Namespace := "https://schemas.microsoft.com/xrm/2011/Metadata")>
Public Enumeration EntityFilters

Members

Member name Description
All

Use this to retrieve all data for an entity. Value = 15.

Attributes

Use this to retrieve entity information plus attributes for the entity. Value = 2.

Default

Use this to retrieve only entity information. Equivalent to EntityFilters.Entity. Value = 1.

Entity

Use this to retrieve only entity information. Equivalent to EntityFilters.Default. Value = 1.

Privileges

Use this to retrieve entity information plus privileges for the entity. Value = 4.

Relationships

Use this to retrieve entity information plus entity relationships for the entity. Value = 8.

Remarks

Use this enumeration with RetrieveAllEntitiesRequest and RetrieveEntityRequest.

See Also

Microsoft.Xrm.Sdk.Metadata Namespace
Sample: Dump entity metadata to a file

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright