TableMetadata

Contains the complete metadata for a Dataverse table, including column definitions, relationship metadata, and primary key/name information.

TableMetadata Class

Properties

Name
Type
Default
Description
ColumnsColumnMetadataCollection
The collection of column metadata for all columns on this table.
IsIntersectbool
False
Indicates whether this table is an intersect (junction) table used to support a many-to-many relationship.
ManyToManyList<ManyToManyMetadata>
Metadata for all many-to-many (N:N) relationships defined on this table.
ManyToOneList<OneToManyMetadata>
Metadata for all many-to-one (N:1) relationships where this table is the referencing (child) table.
ObjectTypeCodeint
0
The numeric object type code assigned to this table by Dataverse.
OneToManyList<OneToManyMetadata>
Metadata for all one-to-many (1:N) relationships where this table is the referenced (parent) table.
PrimaryIdColumnstring
The logical name of the table's primary key column (e.g. 'accountid', 'contactid').
PrimaryImageColumnstring
The logical name of the table's primary image column, if one is configured.
PrimaryNameColumnstring
The logical name of the table's primary name column (e.g. 'name', 'fullname'). This is the column displayed as the record's display name.
TableNamestring
The logical name of the table in Dataverse (e.g. 'account', 'contact').
Name: Columns
Type: ColumnMetadataCollection
Description: The collection of column metadata for all columns on this table.
Name: IsIntersect
Type: bool
Default: False
Description: Indicates whether this table is an intersect (junction) table used to support a many-to-many relationship.
Name: ManyToMany
Type: List<ManyToManyMetadata>
Description: Metadata for all many-to-many (N:N) relationships defined on this table.
Name: ManyToOne
Type: List<OneToManyMetadata>
Description: Metadata for all many-to-one (N:1) relationships where this table is the referencing (child) table.
Name: ObjectTypeCode
Type: int
Default: 0
Description: The numeric object type code assigned to this table by Dataverse.
Name: OneToMany
Type: List<OneToManyMetadata>
Description: Metadata for all one-to-many (1:N) relationships where this table is the referenced (parent) table.
Name: PrimaryIdColumn
Type: string
Description: The logical name of the table's primary key column (e.g. 'accountid', 'contactid').
Name: PrimaryImageColumn
Type: string
Description: The logical name of the table's primary image column, if one is configured.
Name: PrimaryNameColumn
Type: string
Description: The logical name of the table's primary name column (e.g. 'name', 'fullname'). This is the column displayed as the record's display name.
Name: TableName
Type: string
Description: The logical name of the table in Dataverse (e.g. 'account', 'contact').

OneToManyMetadata Class

Properties

Name
Type
Default
Description
ReferencedTablestring
The logical name of the referenced (parent) table — the 'one' side of the relationship.
ReferencedTableColumnstring
The primary key column of the referenced (parent) table.
ReferencingTablestring
The logical name of the referencing (child) table — the 'many' side of the relationship.
ReferencingTableColumnstring
The lookup column on the referencing (child) table that points to the referenced (parent) table.
RelationshipNamestring
The schema name of the relationship in Dataverse.
Name: ReferencedTable
Type: string
Description: The logical name of the referenced (parent) table — the 'one' side of the relationship.
Name: ReferencedTableColumn
Type: string
Description: The primary key column of the referenced (parent) table.
Name: ReferencingTable
Type: string
Description: The logical name of the referencing (child) table — the 'many' side of the relationship.
Name: ReferencingTableColumn
Type: string
Description: The lookup column on the referencing (child) table that points to the referenced (parent) table.
Name: RelationshipName
Type: string
Description: The schema name of the relationship in Dataverse.

ManyToManyMetadata Class

Properties

Name
Type
Default
Description
IntersectTableNamestring
The logical name of the intersect (junction) table that links the two related tables.
RelationshipNamestring
The schema name of the relationship in Dataverse.
Table1string
The logical name of the first table in the relationship.
Table1IntersectColumnstring
The column in the intersect table that references the first table's primary key.
Table1PrimaryKeystring
The primary key column of the first table.
Table2string
The logical name of the second table in the relationship.
Table2IntersectColumnstring
The column in the intersect table that references the second table's primary key.
Table2PrimaryKeystring
The primary key column of the second table.
Name: IntersectTableName
Type: string
Description: The logical name of the intersect (junction) table that links the two related tables.
Name: RelationshipName
Type: string
Description: The schema name of the relationship in Dataverse.
Name: Table1
Type: string
Description: The logical name of the first table in the relationship.
Name: Table1IntersectColumn
Type: string
Description: The column in the intersect table that references the first table's primary key.
Name: Table1PrimaryKey
Type: string
Description: The primary key column of the first table.
Name: Table2
Type: string
Description: The logical name of the second table in the relationship.
Name: Table2IntersectColumn
Type: string
Description: The column in the intersect table that references the second table's primary key.
Name: Table2PrimaryKey
Type: string
Description: The primary key column of the second table.