You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[ShareToPreviousOwnerOnAssign](reference/entities/organization.md#sharetopreviousowneronassign-choicesoptions)|[Sharing and assigning](security-sharing-assigning.md)|
36
+
|[ShareToPreviousOwnerOnAssign](reference/entities/organization.md#BKMK_ShareToPreviousOwnerOnAssign)|[Sharing and assigning](security-sharing-assigning.md)|
37
37
|[ExpireChangeTrackingInDays](reference/entities/organization.md#BKMK_ExpireChangeTrackingInDays)|[Use change tracking to synchronize data with external systems](use-change-tracking-synchronize-data-external-systems.md)|
38
38
|[IsExternalSearchIndexEnabled](reference/entities/organization.md#BKMK_IsExternalSearchIndexEnabled)|[Search for Dataverse records](search/overview.md)|
description: "Use this reference to understand the available operations that can be performed for specific tables, the default columns/attributes of each table/entity and the relationships between tables in Microsoft Dataverse"
4
4
author: phecke
5
5
ms.topic: reference
6
-
ms.date: 03/07/2023
6
+
ms.date: 08/30/2024
7
7
ms.author: pehecke
8
8
ms.reviewer: jdaly
9
9
search.audienceType:
@@ -16,12 +16,12 @@ search.audienceType:
16
16
Use this reference to understand the available operations that can be performed for specific tables, the default columns of each table and the relationships between tables.
17
17
18
18
This reference includes only those tables where:
19
-
-**IsPrivate** equals `false`
20
-
- This excludes tables where no external use cases exist.
21
-
-**IsIntersect** equals `false`
22
-
- This excludes tables used to define Many-to-many relationships.
23
-
- The entity supports some kind of direct data modification operation.
24
-
- This excludes tables that you can't work with directly.
19
+
20
+
-**IsPrivate** equals `false`
21
+
- This excludes tables where no external use cases exist.
22
+
23
+
-**IsIntersect** equals `false` or **IsIntersect** equals `true` and the table contains more than 4 columns.
24
+
- Most intersect tables contain just the 4 columns necessary to support the Many-to-Many relationship. They are not useful. Intersect tables with more than four columns are more interesting.
25
25
26
26
To view information about all tables in your environment, see [Browse tables definitions in your environment](../browse-your-metadata.md).
27
27
@@ -31,7 +31,8 @@ To view information about all tables in your environment, see [Browse tables def
31
31
This section includes selected entity properties rather than all of them. Only those properties expected to be most useful for developers are included. Some entity property values can be changed.
32
32
33
33
## Columns
34
-
Columns are listed in two separate sections: **Writable columns/attributes** and **Read-only columns/attributes**. The purpose of this separation is to focus on the columns a developer can set when creating or updating rows in a table. Understanding these columns helps a developer understand what they can do with the table beyond just retrieving the values.
34
+
35
+
Columns are listed in two separate sections: **Writable columns/attributes** and **Read-only columns/attributes**. The purpose of this separation is to focus on the columns a developer can set when creating or updating rows in a table. Understanding these columns helps a developer understand what they can do with the table beyond just retrieving the values.
35
36
36
37
The columns in the **Writable columns/attributes** section return true for *either* the **IsValidForCreate** or **IsValidForUpdate** properties, (usually both). If either of these properties return false, this is indicated.
37
38
@@ -44,46 +45,65 @@ The [EntityMetadata](/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata) clas
44
45
|Property| Type |Description |
45
46
|---------|---------|---------|
46
47
|[OneToManyRelationships](/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata.onetomanyrelationships#Microsoft_Xrm_Sdk_Metadata_EntityMetadata_OneToManyRelationships)|[OneToManyRelationshipMetadata](/dotnet/api/microsoft.xrm.sdk.metadata.onetomanyrelationshipmetadata)[]|Gets the array of one-to-many relationships for the entity.|
47
-
|[EntityMetadata.ManyToOneRelationships](/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata.manytoonerelationships#Microsoft_Xrm_Sdk_Metadata_EntityMetadata_ManyToOneRelationships)|[OneToManyRelationshipMetadata](/dotnet/api/microsoft.xrm.sdk.metadata.onetomanyrelationshipmetadata)[]|Gets the array of many-to-one relationships for the entity.|
48
-
|[EntityMetadata.ManyToManyRelationships](/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata.manytomanyrelationships#Microsoft_Xrm_Sdk_Metadata_EntityMetadata_ManyToManyRelationships)|[ManyToManyRelationshipMetadata](/dotnet/api/microsoft.xrm.sdk.metadata.manytomanyrelationshipmetadata)[]|Gets the array of many-to-many relationships for the entity.|
48
+
|[ManyToOneRelationships](/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata.manytoonerelationships#Microsoft_Xrm_Sdk_Metadata_EntityMetadata_ManyToOneRelationships)|[OneToManyRelationshipMetadata](/dotnet/api/microsoft.xrm.sdk.metadata.onetomanyrelationshipmetadata)[]|Gets the array of many-to-one relationships for the entity.|
49
+
|[ManyToManyRelationships](/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata.manytomanyrelationships#Microsoft_Xrm_Sdk_Metadata_EntityMetadata_ManyToManyRelationships)|[ManyToManyRelationshipMetadata](/dotnet/api/microsoft.xrm.sdk.metadata.manytomanyrelationshipmetadata)[]|Gets the array of many-to-many relationships for the entity.|
49
50
50
51
> [!NOTE]
51
52
> It is important to keep in mind that while each table lists those relationships that apply to it, each relationship is shared by both tables. The relationships exist *between* the tables. While One-To-Many relationships exist, *Many-to-One* relationships are simply a view of a One-To-Many relationship from the referencing table.
52
53
54
+
### Many-to-One relationships
55
+
56
+
Includes these `OneToManyRelationship` properties:
57
+
58
+
|Property|Description|
59
+
|---------|---------|
60
+
|`ReferencedEntity`|The logical name of the related table.|
61
+
|`ReferencedAttribute`|The logical name of primary key of the related table.|
62
+
|`ReferencingEntity`|The logical name of the related table that has the lookup column.|
63
+
|`ReferencingAttribute`|The logical name of the lookup column in the related table that contains a reference to primary key of the primary table.|
64
+
|`IsHierarchical`|Whether the relationship represents a self-referential hierarchical relationship|
65
+
|`CascadeConfiguration`|Data that describes which operations performed on the parent entity will cascade down to related entities.<br />More information: [Cascade configuration](../entity-relationship-metadata.md#cascade-configuration)|
66
+
67
+
68
+
53
69
### One-to-many relationships
54
-
To represent that there are no actual *Many-to-One* relationships with a minimum confusion, the details of each relationship are only documented once. Each One-to-Many relationship is listed with the referenced table and includes selected relationship details and a link to the corresponding *Many-to-One* relationship. Each *Many-to-One* relationship listed includes only a link to the corresponding One-to-Many relationship.
55
70
56
-
For each one-to-many relationship, the following properties are included:
71
+
Includes these `OneToManyRelationship`properties:
57
72
58
73
|Property|Description|
59
74
|---------|---------|
60
75
|`ReferencingEntity`|The logical name of the related table.|
61
76
|`ReferencingAttribute`|The logical name of the column in the related table that contains a reference to primary key of the primary table.|
62
-
|`IsHierarchical`|Whether the relationship represents a self-referential hierarchical relationship|
63
77
|`IsCustomizable`|Whether the properties of the relationship can be changed.|
64
78
|`ReferencedEntityNavigationPropertyName`|The name of the Web API collection-valued navigation property for this relationship.<br />More information: [Web API Navigation Properties](../webapi/web-api-navigation-properties.md)|
65
79
|`AssociatedMenuConfiguration`|Data used by model-driven apps to control whether and how the related entity data can be accessed in the UI from the primary entity.|
66
-
|`CascadeConfiguration`|Data that describes which operations performed on the parent entity will cascade down to related entities.<br />More information: [Cascade configuration](../entity-relationship-metadata.md#cascade-configuration)|
67
80
68
81
69
82
### Many-to-many relationships
70
-
Each many-to-many relationship includes [Entity1LogicalName](/dotnet/api/microsoft.xrm.sdk.metadata.manytomanyrelationshipmetadata.entity1logicalname) and [Entity2LogicalName](/dotnet/api/microsoft.xrm.sdk.metadata.manytomanyrelationshipmetadata.entity2logicalname). For this documentation, relationship details are only included in the topic for *Entity1*. Each Many-to-Many relationship where the entity is *Entity2* includes only a link to the details found in the topic for *Entity1*.
83
+
84
+
Each many-to-many relationship includes [Entity1LogicalName](/dotnet/api/microsoft.xrm.sdk.metadata.manytomanyrelationshipmetadata.entity1logicalname) and [Entity2LogicalName](/dotnet/api/microsoft.xrm.sdk.metadata.manytomanyrelationshipmetadata.entity2logicalname). For this documentation, relationship details are provided in the context of the current table. Whether it is `Entity1` or `Entity2` isn't really important.
71
85
72
86
For each many-to-many relationship the following properties are included:
73
87
74
88
|Property|Description|
75
89
|---------|---------|
76
90
|`IntersectEntityName`|The logical name of the intersect table that supports this many-to-many relationship|
77
-
|`Entity1LogicalName`|The logical name for the first table in the relationship.|
78
-
|`Entity1IntersectAttribute`|The logical name of the intersect table column that includes a reference to the primary key of the first table.|
79
-
|`Entity1NavigationPropertyName`|The name of the Web API collection-valued navigation property for this relationship.<br />More information: [Web API Navigation Properties](../webapi/web-api-navigation-properties.md)|
80
-
|`Entity1AssociatedMenuConfiguration`|Data used by model-driven apps to control whether and how the first table data can be accessed in the UI from the second table.|
81
-
|`Entity2LogicalName`|The logical name for the second table in the relationship.|
82
-
|`Entity2IntersectAttribute`|The logical name of the intersect table column that includes a reference to the primary key of the second table.|
83
-
|`Entity2NavigationPropertyName`|This is typically the same as the `Entity1NavigationPropertyName`|
84
-
|`Entity2AssociatedMenuConfiguration`|Data used by model-driven apps to control whether and how the second table data can be accessed in the UI from the first table.|
85
91
|`IsCustomizable`|Whether the properties of the relationship can be changed.|
86
-
87
-
92
+
|`SchemaName`|The schema name of the relationship.|
93
+
|`IntersectAttribute`|The name of the column in the intersect table that is the primary key for records of this type.|
94
+
|`NavigationPropertyName`|The name of the Web API collection-valued navigation property for this relationship.<br />More information: [Web API Navigation Properties](../webapi/web-api-navigation-properties.md)|
95
+
|`AssociatedMenuConfiguration`|Data used by model-driven apps to control whether and how the second table data can be accessed in the UI from this table.|
96
+
97
+
98
+
In the rare case where a many-to-many relationship is self-referencing, such as for [Connection Role (ConnectionRole) connectionroleassociation_association](entities/connectionrole.md#BKMK_connectionroleassociation_association), `Entity1` or `Entity2` is prepended to the property.
99
+
100
+
|Property|Value|
101
+
|---|---|
102
+
|`Entity1IntersectAttribute`|The name of the column in the intersect table that is the primary key for records of this type as the first table.|
103
+
|`Entity2IntersectAttribute`|The name of the column in the intersect table that is the primary key for records of this type as the second table.|
104
+
|`Entity1NavigationPropertyName`|The name of the Web API collection-valued navigation property for this relationship as the first table.|
105
+
|`Entity2NavigationPropertyName`|The name of the Web API collection-valued navigation property for this relationship as the second table.|
106
+
|`Entity1AssociatedMenuConfiguration`|Data used by model-driven apps to control whether and how the second table data can be accessed in the UI from this table as the first table.|
107
+
|`Entity2AssociatedMenuConfiguration`|Data used by model-driven apps to control whether and how the second table data can be accessed in the UI from this table as the second table|
0 commit comments