Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

EntityFilters Enum

Definition

Namespace:
Microsoft.Xrm.Sdk.Metadata
Assembly:
Microsoft.Xrm.Sdk.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.2.10

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describes the type of entity metadata to retrieve.

This enumeration supports a bitwise combination of its member values.

public enum class EntityFilters
[System.Flags]
[System.Runtime.Serialization.DataContract(Name="EntityFilters", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")]
public enum EntityFilters
[<System.Flags>]
[<System.Runtime.Serialization.DataContract(Name="EntityFilters", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")>]
type EntityFilters = 
Public Enum EntityFilters
Inheritance
EntityFilters
Attributes

Fields

Name Value Description
Default 1

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

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

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

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

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

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

Remarks

Use this enumeration with RetrieveAllEntitiesRequest and RetrieveEntityRequest.

Applies to