EntityFilters Enum

  • Reference

Definition

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

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
Enum
EntityFilters
Attributes
FlagsAttribute DataContractAttribute

Fields

All 15

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

Use this to retrieve entity information plus attributes for the entity. Value = 2.
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.
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.

Remarks

Use this enumeration with RetrieveAllEntitiesRequest and RetrieveEntityRequest.

Applies to