EntityMetadata EntityType

 

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

Contains the metadata for an entity.

Entity Set path: [organization URI]/api/data/v8.0/EntityDefinitions

Base Type: MetadataBase EntityType

Primary Key: MetadataId

Properties

Collection-valued navigation properties

Properties

Properties represent fields of data stored in the entity.

Name

Type

Description

ActivityTypeMask

Edm.Int32

Whether a custom activity should appear in the activity menus in the Web application.

AutoCreateAccessTeams

Edm.Boolean

Indicates whether the entity is enabled for auto created access teams.

AutoRouteToOwnerQueue

Edm.Boolean

Indicates whether to automatically move records to the owner’s default queue when a record of this type is created or assigned

CanBeInManyToMany

BooleanManagedProperty ComplexType

Whether the entity can be in a Many-to-Many entity relationship.

CanBePrimaryEntityInRelationship

BooleanManagedProperty ComplexType

Whether the entity can be the referenced entity in a One-to-Many entity relationship.

CanBeRelatedEntityInRelationship

BooleanManagedProperty ComplexType

Whether the entity can be the referencing entity in a One-to-Many entity relationship.

CanChangeHierarchicalRelationship

BooleanManagedProperty ComplexType

Whether the hierarchical state of entity relationships included in your managed solutions can be changed.

CanChangeTrackingBeEnabled

BooleanManagedProperty ComplexType

For internal use only.

CanCreateAttributes

BooleanManagedProperty ComplexType

Whether additional attributes can be added to the entity.

CanCreateCharts

BooleanManagedProperty ComplexType

Whether new charts can be created for the entity.

CanCreateForms

BooleanManagedProperty ComplexType

Whether new forms can be created for the entity.

CanCreateViews

BooleanManagedProperty ComplexType

Whether new views can be created for the entity.

CanEnableSyncToExternalSearchIndex

BooleanManagedProperty ComplexType

For internal use only.

CanModifyAdditionalSettings

BooleanManagedProperty ComplexType

Whether any other entity properties not represented by a managed property can be changed.

CanTriggerWorkflow

Edm.Boolean

Whether the entity can trigger a workflow process.

ChangeTrackingEnabled

Edm.Boolean

Whether change tracking is enabled for an entity.

CollectionSchemaName

Edm.String

The collection schema name of the entity.

DaysSinceRecordLastModified

Edm.Int32

[Property Description Not found]

Description

Label ComplexType

The label containing the description for the entity.

DisplayCollectionName

Label ComplexType

A label containing the plural display name for the entity.

DisplayName

Label ComplexType

A label containing the display name for the entity.

EnforceStateTransitions

Edm.Boolean

Whether the entity will enforce custom state transitions.

EntityColor

Edm.String

The hexadecimal code to represent the color to be used for this entity in the application.

EntityHelpUrl

Edm.String

The URL of the resource to display help content for this entity

EntityHelpUrlEnabled

Edm.Boolean

Whether the entity supports custom help content.

EntitySetName

Edm.String

The name of the Web API entity set for this entity.

HasActivities

Edm.Boolean

Whether activities are associated with this entity.

HasChanged

Edm.Boolean

Indicates whether the item of metadata has changed.

Inherited from:MetadataBase EntityType

HasFeedback

Edm.Boolean

Whether the entity will have a special relationship to the Feedback entity.

HasNotes

Edm.Boolean

Whether notes are associated with this entity.

IconLargeName

Edm.String

The name of the image web resource for the large icon for the entity.

IconMediumName

Edm.String

The name of the image web resource for the medium icon for the entity.

IconSmallName

Edm.String

The name of the image web resource for the small icon for the entity.

IntroducedVersion

Edm.String

A string identifying the solution version that the solution component was added in.

IsActivity

Edm.Boolean

Whether the entity is an activity.

IsActivityParty

Edm.Boolean

Whether the email messages can be sent to an email address stored in a record of this type.

IsAIRUpdated

Edm.Boolean

Whether the entity uses the updated user interface.

IsAuditEnabled

BooleanManagedProperty ComplexType

Whether auditing has been enabled for the entity.

IsAvailableOffline

Edm.Boolean

Whether the entity is available offline.

IsBPFEntity

Edm.Boolean

[Property Description Not found]

IsBusinessProcessEnabled

Edm.Boolean

Whether the entity is enabled for business process flows.

IsChildEntity

Edm.Boolean

Whether the entity is a child entity.

IsConnectionsEnabled

BooleanManagedProperty ComplexType

Whether connections are enabled for this entity.

IsCustomEntity

Edm.Boolean

Whether the entity is a custom entity.

IsCustomizable

BooleanManagedProperty ComplexType

Whether the entity is customizable.

IsDocumentManagementEnabled

Edm.Boolean

Whether document management is enabled.

IsDocumentRecommendationsEnabled

Edm.Boolean

[Property Description Not found]

IsDuplicateDetectionEnabled

BooleanManagedProperty ComplexType

Whether duplicate detection is enabled.

IsEnabledForCharts

Edm.Boolean

Whether charts are enabled.

IsEnabledForExternalChannels

Edm.Boolean

Whether this entity is enabled for external channels

IsEnabledForTrace

Edm.Boolean

For internal use only.

IsImportable

Edm.Boolean

Whether the entity can be imported using the Import Wizard.

IsInteractionCentricEnabled

Edm.Boolean

Whether the entity is enabled for interactive experience.

IsIntersect

Edm.Boolean

Whether the entity is an intersection table for two other entities.

IsKnowledgeManagementEnabled

Edm.Boolean

Whether Parature knowledge management integration is enabled for the entity.

IsLogicalEntity

Edm.Boolean

[Property Description Not found]

IsMailMergeEnabled

BooleanManagedProperty ComplexType

Whether mail merge is enabled for this entity.

IsManaged

Edm.Boolean

Whether the entity is part of a managed solution.

IsMappable

BooleanManagedProperty ComplexType

Whether entity mapping is available for the entity.

IsOfflineInMobileClient

BooleanManagedProperty ComplexType

Whether this entity is enabled for offline data with Dynamics 365 for tablets and Dynamics 365 for phones.

IsOneNoteIntegrationEnabled

Edm.Boolean

Whether OneNote integration is enabled for the entity.

IsOptimisticConcurrencyEnabled

Edm.Boolean

Whether optimistic concurrency is enabled for the entity

IsPrivate

Edm.Boolean

For internal use only.

IsQuickCreateEnabled

Edm.Boolean

Whether the entity is enabled for quick create forms.

IsReadingPaneEnabled

Edm.Boolean

For internal use only.

IsReadOnlyInMobileClient

BooleanManagedProperty ComplexType

Whether Microsoft Dynamics 365 for tablets users can update data for this entity.

IsRenameable

BooleanManagedProperty ComplexType

Whether the entity DisplayName and DisplayCollectionName can be changed by editing the entity in the application.

IsSLAEnabled

Edm.Boolean

[Property Description Not found]

IsStateModelAware

Edm.Boolean

Whether the entity supports setting custom state transitions.

IsValidForAdvancedFind

Edm.Boolean

Whether the entity is will be shown in Advanced Find.

IsValidForQueue

BooleanManagedProperty ComplexType

Whether the entity is enabled for queues.

IsVisibleInMobile

BooleanManagedProperty ComplexType

Whether Microsoft Dynamics 365 for phones users can see data for this entity.

IsVisibleInMobileClient

BooleanManagedProperty ComplexType

Whether Microsoft Dynamics 365 for tablets users can see data for this entity.

LogicalCollectionName

Edm.String

The logical collection name.

LogicalName

Edm.String

The logical name for the entity.

MetadataId

Edm.Guid

A unique identifier for the metadata item.

Inherited from:MetadataBase EntityType

MobileOfflineFilters

Edm.String

[Property Description Not found]

ObjectTypeCode

Edm.Int32

The entity type code.

OwnershipType

OwnershipTypes EnumType

The ownership type for the entity.

PrimaryIdAttribute

Edm.String

The name of the attribute that is the primary id for the entity.

PrimaryImageAttribute

Edm.String

The name of the primary image attribute for an entity.

PrimaryNameAttribute

Edm.String

The name of the primary attribute for an entity.

Privileges

Collection(SecurityPrivilegeMetadata ComplexType)

The privilege metadata for the entity.

RecurrenceBaseEntityLogicalName

Edm.String

The name of the entity that is recurring.

ReportViewName

Edm.String

The name of the report view for the entity.

SchemaName

Edm.String

The schema name for the entity.

SyncToExternalSearchIndex

Edm.Boolean

[Property Description Not found]

UsesBusinessDataLabelTable

Edm.Boolean

[Property Description Not found]

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name

Type

Attributes

AttributeMetadata EntityType

Keys

EntityKeyMetadata EntityType

ManyToManyRelationships

ManyToManyRelationshipMetadata EntityType

ManyToOneRelationships

OneToManyRelationshipMetadata EntityType

OneToManyRelationships

OneToManyRelationshipMetadata EntityType

See Also

Web API EntityType Reference
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Use the Web API with Dynamics 365 metadata

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright