ComplexEntityMetadata ComplexType

Contains the metadata for a complex entity.

Properties

The properties of a complex type contain the structured data of the type.

Name Type Details
ActivityTypeMask Edm.Int32

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

Attributes Collection(ComplexAttributeMetadata)

Collection of attributes.

AutoRouteToOwnerQueue Edm.Boolean

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

CanTriggerWorkflow Edm.Boolean

Whether the complex entity can trigger a workflow process.

Description Label

The label containing the description for the complex entity.

DisplayCollectionName Label

A label containing the plural display name for the complex entity.

DisplayName Label

A label containing the display name for the complex entity.

EntityHelpUrlEnabled Edm.Boolean

Whether the entity supports custom help content.

EntityHelpUrl Edm.String

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

IsDocumentManagementEnabled Edm.Boolean

Whether document management is enabled.

IsOneNoteIntegrationEnabled Edm.Boolean

Whether OneNote integration is enabled for the complex entity.

IsInteractionCentricEnabled Edm.Boolean

Whether interactive service hub dashboards are enabled for this complex entity.

IsKnowledgeManagementEnabled Edm.Boolean

Whether Parature knowledge management integration is enabled for the complex entity.

IsSLAEnabled Edm.Boolean

Indicating if the entity is enabled for service level agreements (SLAs).

IsBPFEntity Edm.Boolean

For internal use only

IsDocumentRecommendationsEnabled Edm.Boolean

For internal use only. Whether the entity is enabled for document recommendations.

DataProviderId Edm.Guid
DataSourceId Edm.Guid
AutoCreateAccessTeams Edm.Boolean

Whether the complex entity is enabled for auto created access teams.

IsActivity Edm.Boolean

Whether the complex 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.

IsAuditEnabled BooleanManagedProperty

Whether auditing has been enabled for the complex entity.

IsAvailableOffline Edm.Boolean

Whether the complex entity is available offline.

IsChildEntity Edm.Boolean

Whether the complex entity is a child entity.

IsAIRUpdated Edm.Boolean

Whether the complex entity uses the updated user interface.

IsValidForQueue BooleanManagedProperty

Whether the complex entity is enabled for queues.

IsConnectionsEnabled BooleanManagedProperty

Whether connections are enabled for this complex entity.

IconLargeName Edm.String

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

IconMediumName Edm.String

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

IconSmallName Edm.String

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

IconVectorName Edm.String
IsCustomEntity Edm.Boolean

Whether the complex entity is a custom entity.

IsBusinessProcessEnabled Edm.Boolean

Whether the complex entity is enabled for business process flows.

IsCustomizable BooleanManagedProperty

Whether the complex entity is customizable.

IsRenameable BooleanManagedProperty

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

IsMappable BooleanManagedProperty

Whether entity mapping is available for the complex entity.

IsDuplicateDetectionEnabled BooleanManagedProperty

Whether duplicate detection is enabled.

CanCreateAttributes BooleanManagedProperty

Whether additional attributes can be added to the complex entity.

CanCreateForms BooleanManagedProperty

Whether new forms can be created for the complex entity.

CanCreateViews BooleanManagedProperty

Whether new views can be created for the complex entity.

CanCreateCharts BooleanManagedProperty

Whether new charts can be created for the complex entity.

CanBeRelatedEntityInRelationship BooleanManagedProperty

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

CanBePrimaryEntityInRelationship BooleanManagedProperty

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

CanBeInManyToMany BooleanManagedProperty

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

CanEnableSyncToExternalSearchIndex BooleanManagedProperty

For internal use only.

SyncToExternalSearchIndex Edm.Boolean

Whether the complex entity can be synced to external search index.

CanModifyAdditionalSettings BooleanManagedProperty

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

CanChangeHierarchicalRelationship BooleanManagedProperty

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

IsOptimisticConcurrencyEnabled Edm.Boolean

Whether optimistic concurrency is enabled for the complex entity.

ChangeTrackingEnabled Edm.Boolean

Whether change tracking is enabled for the complex entity.

CanChangeTrackingBeEnabled BooleanManagedProperty

Whether change tracking can be enabled for the complex entity.

IsImportable Edm.Boolean

Whether the complex entity can be imported using the Import Wizard.

IsIntersect Edm.Boolean

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

IsMailMergeEnabled BooleanManagedProperty

Whether mail merge is enabled for this complex entity.

IsManaged Edm.Boolean

Whether the complex entity is part of a managed solution.

IsEnabledForCharts Edm.Boolean

Whether charts are enabled.

IsEnabledForTrace Edm.Boolean

For internal use only.

IsValidForAdvancedFind Edm.Boolean

Whether the entity will be shown in Advanced Find.

IsVisibleInMobile BooleanManagedProperty

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

IsVisibleInMobileClient BooleanManagedProperty

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

IsReadOnlyInMobileClient BooleanManagedProperty

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

IsOfflineInMobileClient BooleanManagedProperty

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

DaysSinceRecordLastModified Edm.Int32

The number of days since the record was last modified.

MobileOfflineFilters Edm.String

For internal use only.

IsReadingPaneEnabled Edm.Boolean

For internal use only.

IsQuickCreateEnabled Edm.Boolean

Whether the complex entity is enabled for quick create forms.

LogicalName Edm.String

The logical name for the complex entity.

ManyToManyRelationships Collection(ComplexManyToManyRelationshipMetadata)

Array of many to many relationships for the complex entity.

ManyToOneRelationships Collection(ComplexOneToManyRelationshipMetadata)

Array of many to one relationships for the complex entity.

OneToManyRelationships Collection(ComplexOneToManyRelationshipMetadata)

Array of many to one relationships for the complex entity.

ObjectTypeCode Edm.Int32

The complex entity type code.

OwnershipType OwnershipTypes

The ownership type for the complex entity.

PrimaryNameAttribute Edm.String

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

PrimaryImageAttribute Edm.String

The name of the primary image attribute for the complex entity.

PrimaryIdAttribute Edm.String

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

Privileges Collection(SecurityPrivilegeMetadata)

The privilege metadata for the complex entity.

RecurrenceBaseEntityLogicalName Edm.String

The name of the complex entity that is recurring.

ReportViewName Edm.String

The name of the report view for the complex entity.

SchemaName Edm.String

The schema name for the complex entity.

IntroducedVersion Edm.String

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

IsStateModelAware Edm.Boolean

Whether the complex entity supports setting custom state transitions.

EnforceStateTransitions Edm.Boolean

Whether the entity will enforce custom state transitions.

ExternalName Edm.String
EntityColor Edm.String

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

Keys Collection(ComplexEntityKeyMetadata)

Array of keys for the complex entity.

LogicalCollectionName Edm.String

The logical collection name.

ExternalCollectionName Edm.String
CollectionSchemaName Edm.String

The collection schema name of the complex entity.

EntitySetName Edm.String

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

IsEnabledForExternalChannels Edm.Boolean

For internal use only.

IsPrivate Edm.Boolean

For internal use only.

UsesBusinessDataLabelTable Edm.Boolean

For internal use only.

IsLogicalEntity Edm.Boolean

For internal use only.

MetadataId Edm.Guid

A unique identifier for the metadata item.

HasChanged Edm.Boolean

Indicates whether the item of metadata has changed.

Used by

The following use the ComplexEntityMetadata ComplexType.

Name How used
RetrieveAllEntitiesResponse Property
RetrieveEntityResponse Property
RetrieveMetadataChangesResponse Property

See also