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. |
| AutoCreateAccessTeams | Edm.Boolean |
Whether the complex entity is enabled for auto created access teams. |
| AutoRouteToOwnerQueue | Edm.Boolean |
Whether to automatically move records to the owner's default queue when a record of this type is created or assigned. |
| CanBeInCustomEntityAssociation | BooleanManagedProperty | |
| CanBeInManyToMany | BooleanManagedProperty |
Whether the complex entity can be in a Many-to-Many entity relationship. |
| CanBePrimaryEntityInRelationship | BooleanManagedProperty |
Whether the complex entity can be the referenced entity in a One-to-Many entity relationship. |
| CanBeRelatedEntityInRelationship | BooleanManagedProperty |
Whether the complex entity can be the referencing entity in a One-to-Many entity relationship |
| CanChangeHierarchicalRelationship | BooleanManagedProperty |
Whether the hierarchical state of entity relationships included in your managed solutions can be changed. |
| CanChangeTrackingBeEnabled | BooleanManagedProperty |
Whether change tracking can be enabled for the complex entity. |
| CanCreateAttributes | BooleanManagedProperty |
Whether additional attributes can be added to the complex entity. |
| CanCreateCharts | BooleanManagedProperty |
Whether new charts can be created for 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. |
| CanEnableSyncToExternalSearchIndex | BooleanManagedProperty |
For internal use only. |
| CanModifyAdditionalSettings | BooleanManagedProperty |
Whether any other entity properties not represented by a managed property can be changed. |
| CanTriggerWorkflow | Edm.Boolean |
Whether the complex entity can trigger a workflow process. |
| ChangeTrackingEnabled | Edm.Boolean |
Whether change tracking is enabled for the complex entity. |
| ClusterMode | EntityClusterMode | |
| CollectionSchemaName | Edm.String |
The collection schema name of the complex entity. |
| CreatedOn | Edm.DateTimeOffset |
When the column was created. |
| DataProviderId | Edm.Guid | |
| DataSourceId | Edm.Guid | |
| DaysSinceRecordLastModified | Edm.Int32 |
The number of days since the record was last modified. |
| 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. |
| 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 complex entity in the application. |
| EntityHelpUrl | Edm.String |
The URL of the resource to display help content for this complex 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. |
| ExternalCollectionName | Edm.String | |
| ExternalName | Edm.String |
The external name of an object, typically based on it's name in it's original source. |
| HasActivities | Edm.Boolean | |
| HasChanged | Edm.Boolean |
Indicates whether the item of metadata has changed. |
| HasEmailAddresses | Edm.Boolean |
Whether or not an email address is associated to this entity. |
| HasFeedback | Edm.Boolean |
Whether or not feedback items are associated to this 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 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 | |
| IntroducedVersion | Edm.String |
A string identifying the solution version that the solution component was added in. |
| 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. |
| IsAIRUpdated | Edm.Boolean |
Whether the complex entity uses the updated user interface. |
| IsArchivalEnabled | Edm.Boolean |
Whether or not the entity is enabled for archival of rows. |
| IsAuditEnabled | BooleanManagedProperty |
Whether auditing has been enabled for the complex entity. |
| IsAvailableOffline | Edm.Boolean |
Whether the complex entity is available offline. |
| IsBPFEntity | Edm.Boolean |
For internal use only |
| IsBusinessProcessEnabled | Edm.Boolean |
Whether the complex entity is enabled for business process flows. |
| IsChildEntity | Edm.Boolean |
Whether the complex entity is a child entity. |
| IsConnectionsEnabled | BooleanManagedProperty |
Whether connections are enabled for this complex entity. |
| IsCustomEntity | Edm.Boolean |
Whether the complex entity is a custom entity. |
| IsCustomizable | BooleanManagedProperty |
Whether the complex entity is customizable. |
| IsDocumentManagementEnabled | Edm.Boolean |
Whether document management is enabled. |
| IsDocumentRecommendationsEnabled | Edm.Boolean |
For internal use only. Whether the entity is enabled for document recommendations. |
| IsDuplicateDetectionEnabled | BooleanManagedProperty |
Whether duplicate detection is enabled. |
| IsEnabledForCharts | Edm.Boolean |
Whether charts are enabled. |
| IsEnabledForExternalChannels | Edm.Boolean |
For internal use only. |
| IsEnabledForTrace | Edm.Boolean |
For internal use only. |
| IsImportable | Edm.Boolean |
Whether the complex entity can be imported using the Import Wizard. |
| IsInteractionCentricEnabled | Edm.Boolean |
Whether interactive service hub dashboards are enabled for this complex entity. |
| IsIntersect | Edm.Boolean |
Whether the complex entity is an intersection table for two other entities. |
| IsKnowledgeManagementEnabled | Edm.Boolean |
Whether Parature knowledge management integration is enabled for the complex entity. |
| IsLogicalEntity | Edm.Boolean |
For internal use only. |
| IsMailMergeEnabled | BooleanManagedProperty |
Whether mail merge is enabled for this complex entity. |
| IsManaged | Edm.Boolean |
Whether the complex entity is part of a managed solution. |
| IsMappable | BooleanManagedProperty |
Whether entity mapping is available for the complex entity. |
| IsMSTeamsIntegrationEnabled | Edm.Boolean |
Whether or not the entity is enabled for Microsoft Teams integration. |
| IsOfflineInMobileClient | BooleanManagedProperty |
Whether this complex 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 complex entity. |
| IsOptimisticConcurrencyEnabled | Edm.Boolean |
Whether optimistic concurrency is enabled for the complex entity. |
| IsPrivate | Edm.Boolean |
For internal use only. |
| IsQuickCreateEnabled | Edm.Boolean |
Whether the complex entity is enabled for quick create forms. |
| IsReadingPaneEnabled | Edm.Boolean |
For internal use only. |
| IsReadOnlyInMobileClient | BooleanManagedProperty |
Whether Microsoft Dynamics 365 for tablets users can update data for this complex entity. |
| IsRenameable | BooleanManagedProperty |
Whether the entity DisplayName and DisplayCollectionName can be changed by editing the complex entity in the application. |
| IsRetentionEnabled | Edm.Boolean |
Whether the table is enabled for retention. |
| IsRetrieveAuditEnabled | Edm.Boolean | |
| IsRetrieveMultipleAuditEnabled | Edm.Boolean | |
| IsSLAEnabled | Edm.Boolean |
Indicating if the entity is enabled for service level agreements (SLAs). |
| IsSolutionAware | Edm.Boolean |
For internal use only. |
| IsStateModelAware | Edm.Boolean |
Whether the complex entity supports setting custom state transitions. |
| IsValidForAdvancedFind | Edm.Boolean |
Whether the entity will be shown in Advanced Find. |
| IsValidForQueue | BooleanManagedProperty |
Whether the complex entity is enabled for queues. |
| 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. |
| Keys | Collection(ComplexEntityKeyMetadata) |
Array of keys for the complex entity. |
| LogicalCollectionName | Edm.String |
The logical collection name. |
| 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. |
| MetadataId | Edm.Guid |
A unique identifier for the metadata item. |
| MobileOfflineFilters | Edm.String |
For internal use only. |
| ModifiedOn | Edm.DateTimeOffset |
When the table was last modified. |
| ObjectTypeCode | Edm.Int32 |
The complex entity type code. |
| OneToManyRelationships | Collection(ComplexOneToManyRelationshipMetadata) |
Array of many to one relationships for the complex entity. |
| OwnerId | Edm.Guid | |
| OwnerIdType | Edm.Int32 | |
| OwnershipType | OwnershipTypes |
The ownership type for the complex entity. |
| OwningBusinessUnit | Edm.Guid |
The owning business unit for the entity. |
| PrimaryIdAttribute | 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. |
| PrimaryNameAttribute | 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. |
| SettingOf | Edm.String | |
| Settings | Collection(EntitySetting) |
For internal use only. |
| SyncToExternalSearchIndex | Edm.Boolean |
Whether the complex entity can be synced to external search index. |
| TableType | Edm.String |
Whether the table is standard or elastic. |
| UsesBusinessDataLabelTable | Edm.Boolean |
For internal use only. |
Used by
The following use the ComplexEntityMetadata ComplexType.
| Name | How used |
|---|---|
| RetrieveAllEntitiesResponse | EntityMetadata Property |
| RetrieveEntityResponse | EntityMetadata Property |
| RetrieveMetadataChangesResponse | EntityMetadata Property |