Entity table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Messages
Message | Web API Operation | SDK class or method |
---|---|---|
RetrieveMultiple | GET /entities See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
Properties
Property | Value |
---|---|
CollectionSchemaName | Entities |
DisplayCollectionName | Entities |
DisplayName | Entity |
EntitySetName | entities |
IsBPFEntity | False |
LogicalCollectionName | entities |
LogicalName | entity |
OwnershipType | None |
PrimaryIdAttribute | entityid |
PrimaryNameAttribute | name |
SchemaName | Entity |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AddressTableName
- BaseTableName
- CollectionName
- EntityId
- EntitySetName
- ExtensionTableName
- ExternalCollectionName
- ExternalName
- LogicalCollectionName
- LogicalName
- Name
- OriginalLocalizedCollectionName
- OriginalLocalizedName
- ParentControllingAttributeName
- PhysicalName
- ReportViewName
AddressTableName
Property | Value |
---|---|
Description | The address table name of this entity. |
DisplayName | Address Table Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | addresstablename |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
BaseTableName
Property | Value |
---|---|
Description | The base table name of this entity. |
DisplayName | Base Table Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | basetablename |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
CollectionName
Property | Value |
---|---|
Description | The collection name of this entity. |
DisplayName | Collection Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | collectionname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
EntityId
Property | Value |
---|---|
Description | Unique identifier of the entity. |
DisplayName | Entity |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | entityid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
EntitySetName
Property | Value |
---|---|
Description | The entity set name of this entity. |
DisplayName | Entity Set Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | entitysetname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
ExtensionTableName
Property | Value |
---|---|
Description | The extension table name of this entity. |
DisplayName | Extension Table Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | extensiontablename |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
ExternalCollectionName
Property | Value |
---|---|
Description | The external collection name of this entity. |
DisplayName | External Collection Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | externalcollectionname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
ExternalName
Property | Value |
---|---|
Description | The external name of this entity. |
DisplayName | External Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | externalname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
LogicalCollectionName
Property | Value |
---|---|
Description | The logical collection name of this entity. |
DisplayName | Logical Collection Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | logicalcollectionname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
LogicalName
Property | Value |
---|---|
Description | The logical name of this entity. |
DisplayName | Logical Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | logicalname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
Name
Property | Value |
---|---|
Description | The name of this Entity. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | name |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
OriginalLocalizedCollectionName
Property | Value |
---|---|
Description | The original localized collection name of this entity. |
DisplayName | Original Localized Collection Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | originallocalizedcollectionname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
OriginalLocalizedName
Property | Value |
---|---|
Description | The original localized name of this entity. |
DisplayName | Original Localized Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | originallocalizedname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
ParentControllingAttributeName
Property | Value |
---|---|
Description | The parent controlling attribute name of this entity. |
DisplayName | Parent Controlling Attribute Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | parentcontrollingattributename |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
PhysicalName
Property | Value |
---|---|
Description | The physical name of this entity. |
DisplayName | Physical Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | physicalname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
ReportViewName
Property | Value |
---|---|
Description | The Report view name of this entity. |
DisplayName | Report View Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | reportviewname |
MaxLength | 128 |
RequiredLevel | None |
Type | String |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
ComponentState
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
0 | Published | |
1 | Unpublished | |
2 | Deleted | |
3 | Deleted Unpublished |
IsActivity
Added by: Metadata Extension Solution
Property | Value |
---|---|
Description | Whether this entity is of type activity. |
DisplayName | Is Activity |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | isactivity |
RequiredLevel | None |
Type | Boolean |
IsActivity Choices/Options
Value | Label | Description |
---|
ObjectTypeCode
Added by: Metadata Extension Solution
Property | Value |
---|---|
Description | The object type code of this entity. |
DisplayName | Object Type Code |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | objecttypecode |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
OverwriteTime
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | For internal use only. |
DisplayName | Record Overwrite Time |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
SolutionId
Property | Value |
---|---|
Description | Unique identifier of the associated solution. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | solutionid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
VersionNumber
Added by: Metadata Extension Solution
Property | Value |
---|---|
Description | The version number of this entity. |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- entity_solutioncomponentconfiguration
- entity_solutioncomponentbatchconfiguration_PrimaryEntity
- entity_solutioncomponentbatchconfiguration_RelatedEntity
- catalogassignment_entity
- entity_entityanalyticsconfig
- sharedlinksetting_extensionofrecordid
- entity_serviceplanmapping
- DVFileSearchEntity_Entity_Entity
- DVTableSearchEntity_Entity_Entity
- AIPluginOperation_Entity_Entity
- virtualentitymetadata_extensionofrecordid
- metadataforarchival_extensionofrecordid
- msdyn_insightsstorevirtualentity_extensionofrecordid
- recyclebinconfig_extensionofrecordid
- entity_appaction_ContextEntity
- entity_appactionrule_ContextEntity
- msdyn_entity_msdyn_entitylinkchatconfiguration
entity_solutioncomponentconfiguration
Added by: Solution Component Configuration Solution
Same as the entity_solutioncomponentconfiguration many-to-one relationship for the solutioncomponentconfiguration table/entity.
Property | Value |
---|---|
ReferencingEntity | solutioncomponentconfiguration |
ReferencingAttribute | entityid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | entity_solutioncomponentconfiguration |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
entity_solutioncomponentbatchconfiguration_PrimaryEntity
Added by: Solution Component Configuration Solution
Same as the entity_solutioncomponentbatchconfiguration_PrimaryEntity many-to-one relationship for the solutioncomponentbatchconfiguration table/entity.
Property | Value |
---|---|
ReferencingEntity | solutioncomponentbatchconfiguration |
ReferencingAttribute | primaryentity |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | entity_solutioncomponentbatchconfiguration_PrimaryEntity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
entity_solutioncomponentbatchconfiguration_RelatedEntity
Added by: Solution Component Configuration Solution
Same as the entity_solutioncomponentbatchconfiguration_RelatedEntity many-to-one relationship for the solutioncomponentbatchconfiguration table/entity.
Property | Value |
---|---|
ReferencingEntity | solutioncomponentbatchconfiguration |
ReferencingAttribute | relatedentity |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | entity_solutioncomponentbatchconfiguration_RelatedEntity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
catalogassignment_entity
Added by: CatalogFramework Solution
Same as the catalogassignment_entity many-to-one relationship for the catalogassignment table/entity.
Property | Value |
---|---|
ReferencingEntity | catalogassignment |
ReferencingAttribute | object |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | CatalogAssignments |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
entity_entityanalyticsconfig
Added by: Advanced Analytics Infrastructure Solution
Same as the entity_entityanalyticsconfig many-to-one relationship for the entityanalyticsconfig table/entity.
Property | Value |
---|---|
ReferencingEntity | entityanalyticsconfig |
ReferencingAttribute | parententityid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | entity_entityanalyticsconfig |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
sharedlinksetting_extensionofrecordid
Added by: Active Solution Solution
Same as the sharedlinksetting_extensionofrecordid many-to-one relationship for the sharedlinksetting table/entity.
Property | Value |
---|---|
ReferencingEntity | sharedlinksetting |
ReferencingAttribute | extensionofrecordid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | sharedlinksetting_extensionofrecordid |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
entity_serviceplanmapping
Added by: License Enforcement Solution
Same as the entity_serviceplanmapping many-to-one relationship for the serviceplanmapping table/entity.
Property | Value |
---|---|
ReferencingEntity | serviceplanmapping |
ReferencingAttribute | entity |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | entity_serviceplanmapping |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
DVFileSearchEntity_Entity_Entity
Added by: AIPlatformExtensionsComponents Solution Solution
Same as the DVFileSearchEntity_Entity_Entity many-to-one relationship for the dvfilesearchentity table/entity.
Property | Value |
---|---|
ReferencingEntity | dvfilesearchentity |
ReferencingAttribute | entity |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | DVFileSearchEntity_Entity_Entity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
DVTableSearchEntity_Entity_Entity
Added by: AIPlatformExtensionsComponents Solution Solution
Same as the DVTableSearchEntity_Entity_Entity many-to-one relationship for the dvtablesearchentity table/entity.
Property | Value |
---|---|
ReferencingEntity | dvtablesearchentity |
ReferencingAttribute | entity |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | DVTableSearchEntity_Entity_Entity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
AIPluginOperation_Entity_Entity
Added by: AIPlatformExtensionsCore Solution Solution
Same as the AIPluginOperation_Entity_Entity many-to-one relationship for the aipluginoperation table/entity.
Property | Value |
---|---|
ReferencingEntity | aipluginoperation |
ReferencingAttribute | entity |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | AIPluginOperation_Entity_Entity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
virtualentitymetadata_extensionofrecordid
Added by: Active Solution Solution
Same as the virtualentitymetadata_extensionofrecordid many-to-one relationship for the virtualentitymetadata table/entity.
Property | Value |
---|---|
ReferencingEntity | virtualentitymetadata |
ReferencingAttribute | extensionofrecordid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | virtualentitymetadata_extensionofrecordid |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
metadataforarchival_extensionofrecordid
Added by: Active Solution Solution
Same as the metadataforarchival_extensionofrecordid many-to-one relationship for the metadataforarchival table/entity.
Property | Value |
---|---|
ReferencingEntity | metadataforarchival |
ReferencingAttribute | extensionofrecordid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | metadataforarchival_extensionofrecordid |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
msdyn_insightsstorevirtualentity_extensionofrecordid
Added by: Active Solution Solution
Same as the msdyn_insightsstorevirtualentity_extensionofrecordid many-to-one relationship for the msdyn_insightsstorevirtualentity table/entity.
Property | Value |
---|---|
ReferencingEntity | msdyn_insightsstorevirtualentity |
ReferencingAttribute | extensionofrecordid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | msdyn_insightsstorevirtualentity_extensionofrecordid |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
recyclebinconfig_extensionofrecordid
Added by: Active Solution Solution
Same as the recyclebinconfig_extensionofrecordid many-to-one relationship for the recyclebinconfig table/entity.
Property | Value |
---|---|
ReferencingEntity | recyclebinconfig |
ReferencingAttribute | extensionofrecordid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | recyclebinconfig_extensionofrecordid |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
entity_appaction_ContextEntity
Added by: Power Apps Actions Solution
Same as the entity_appaction_ContextEntity many-to-one relationship for the appaction table/entity.
Property | Value |
---|---|
ReferencingEntity | appaction |
ReferencingAttribute | contextentity |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | entity_appaction_ContextEntity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
entity_appactionrule_ContextEntity
Added by: Power Apps Actions Solution
Same as the entity_appactionrule_ContextEntity many-to-one relationship for the appactionrule table/entity.
Property | Value |
---|---|
ReferencingEntity | appactionrule |
ReferencingAttribute | contextentity |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | entity_appactionrule_ContextEntity |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
msdyn_entity_msdyn_entitylinkchatconfiguration
Added by: Teams Chat Settings Solution Solution
Same as the msdyn_entity_msdyn_entitylinkchatconfiguration many-to-one relationship for the msdyn_entitylinkchatconfiguration table/entity.
Property | Value |
---|---|
ReferencingEntity | msdyn_entitylinkchatconfiguration |
ReferencingAttribute | msdyn_entitytype |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | msdyn_entity_msdyn_entitylinkchatconfiguration_entitytype |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-Many Relationships
Relationship details provided where the Entity table is the first table in the relationship. Listed by SchemaName.
card_entity_connections
See the card_entity_connections many-to-many relationship for the card table/entity.
See also
Dataverse table/entity reference
Web API Reference
entity EntityType
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for