ComplexEntityMetadata ComplexType
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the metadata for a complex entity.
Properties
The properties of a complex type contain the structured data of the type.
Name |
Type |
Nullable |
Unicode |
Description |
|---|---|---|---|---|
ActivityTypeMask |
Edm.Int32 |
Whether a custom activity should appear in the activity menus in the Web application. |
||
Attributes |
Collection(ComplexAttributeMetadata ComplexType) |
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. |
||
CanBeInManyToMany |
Whether the complex entity can be in a Many-to-Many entity relationship. |
|||
CanBePrimaryEntityInRelationship |
Whether the complex entity can be the referenced entity in a One-to-Many entity relationship. |
|||
CanBeRelatedEntityInRelationship |
Whether the complex entity can be the referencing entity in a One-to-Many entity relationship |
|||
CanChangeHierarchicalRelationship |
Whether the hierarchical state of entity relationships included in your managed solutions can be changed. |
|||
CanChangeTrackingBeEnabled |
Whether change tracking can be enabled for the complex entity. |
|||
CanCreateAttributes |
Whether additional attributes can be added to the complex entity. |
|||
CanCreateCharts |
Whether new charts can be created for the complex entity. |
|||
CanCreateForms |
Whether new forms can be created for the complex entity. |
|||
CanCreateViews |
Whether new views can be created for the complex entity. |
|||
CanEnableSyncToExternalSearchIndex |
For internal use only. |
|||
CanModifyAdditionalSettings |
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. |
||
CollectionSchemaName |
Edm.String |
false |
The collection schema name of the complex entity. |
|
DaysSinceRecordLastModified |
Edm.Int32 |
The number of days since the record was last modified. |
||
Description |
The label containing the description for the complex entity. |
|||
DisplayCollectionName |
A label containing the plural display name for the complex entity. |
|||
DisplayName |
A label containing the display name for the complex entity. |
|||
EnforceStateTransitions |
Edm.Boolean |
Whether the entity will enforce custom state transitions. |
||
EntityColor |
Edm.String |
false |
The hexadecimal code to represent the color to be used for this complex entity in the application. |
|
EntityHelpUrl |
Edm.String |
false |
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 |
false |
The name of the Web API entity set for this entity. |
|
HasChanged |
Edm.Boolean |
Indicates whether the item of metadata has changed. |
||
IconLargeName |
Edm.String |
false |
The name of the image web resource for the large icon for the complex entity. |
|
IconMediumName |
Edm.String |
false |
The name of the image web resource for the medium icon for the complex entity. |
|
IconSmallName |
Edm.String |
false |
The name of the image web resource for the small icon for the complex entity. |
|
IntroducedVersion |
Edm.String |
false |
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. |
||
IsAuditEnabled |
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 |
Whether connections are enabled for this complex entity. |
|||
IsCustomEntity |
Edm.Boolean |
Whether the complex entity is a custom entity. |
||
IsCustomizable |
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 |
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 |
Whether mail merge is enabled for this complex entity. |
|||
IsManaged |
Edm.Boolean |
Whether the complex entity is part of a managed solution. |
||
IsMappable |
Whether entity mapping is available for the complex entity. |
|||
IsOfflineInMobileClient |
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 |
Whether Microsoft Dynamics 365 for tablets users can update data for this complex entity. |
|||
IsRenameable |
Whether the entity DisplayName and DisplayCollectionName can be changed by editing the complex entity in the application. |
|||
IsSLAEnabled |
Edm.Boolean |
Indicating if the entity is enabled for service level agreements (SLAs). |
||
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 |
Whether the complex entity is enabled for queues. |
|||
IsVisibleInMobile |
Whether Microsoft Dynamics 365 for phones users can see data for this complex entity. |
|||
IsVisibleInMobileClient |
Whether Microsoft Dynamics 365 for tablets users can see data for this complex entity. |
|||
Keys |
Collection(ComplexEntityKeyMetadata ComplexType) |
Array of keys for the complex entity. |
||
LogicalCollectionName |
Edm.String |
false |
The logical collection name. |
|
LogicalName |
Edm.String |
false |
The logical name for the complex entity. |
|
ManyToManyRelationships |
Collection(ComplexManyToManyRelationshipMetadata ComplexType) |
Array of many to many relationships for the complex entity. |
||
ManyToOneRelationships |
Collection(ComplexOneToManyRelationshipMetadata ComplexType) |
Array of many to one relationships for the complex entity. |
||
MetadataId |
Edm.Guid |
A unique identifier for the metadata item. |
||
MobileOfflineFilters |
Edm.String |
false |
For internal use only. |
|
ObjectTypeCode |
Edm.Int32 |
The complex entity type code. |
||
OneToManyRelationships |
Collection(ComplexOneToManyRelationshipMetadata ComplexType) |
Array of many to one relationships for the complex entity. |
||
OwnershipType |
The ownership type for the complex entity. |
|||
PrimaryIdAttribute |
Edm.String |
false |
The name of the attribute that is the primary id for the complex entity. |
|
PrimaryImageAttribute |
Edm.String |
false |
The name of the primary image attribute for the complex entity. |
|
PrimaryNameAttribute |
Edm.String |
false |
The name of the attribute that is the primary id for the complex entity. |
|
Privileges |
Collection(SecurityPrivilegeMetadata ComplexType) |
The privilege metadata for the complex entity. |
||
RecurrenceBaseEntityLogicalName |
Edm.String |
false |
The name of the complex entity that is recurring. |
|
ReportViewName |
Edm.String |
false |
The name of the report view for the complex entity. |
|
SchemaName |
Edm.String |
false |
The schema name for the complex entity. |
|
SyncToExternalSearchIndex |
Edm.Boolean |
Whether the complex entity can be synced to external search index. |
||
UsesBusinessDataLabelTable |
Edm.Boolean |
For internal use only. |
Types that use the ComplexEntityMetadata complex type.
The following use the ComplexEntityMetadata complex type.
Name |
How used |
Description |
|---|---|---|
EntityMetadata Property |
Contains the response from the RetrieveAllEntities function. |
See Also
Use the Microsoft Dynamics 365 Web API
Web API EntityType Reference
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright