LookupMetadata

Metadata for a Dataverse lookup (entity reference) column, including the target tables this lookup can reference.

LookupMetadata Class

Properties

Name
Type
Default
Description
ColumnNamestring
The logical name of the column in Dataverse (e.g. 'firstname', 'emailaddress1').
ColumnTypeColumnType
Lookup
Returns Lookup.
Descriptionstring?
The localized description of the column, or null if no description is configured.
DisplayNamestring
The localized display name of the column as configured in Dataverse.
IsValidForCreatebool
False
Indicates whether this column can be set when creating a new record.
IsValidForUpdatebool
False
Indicates whether this column can be modified when updating an existing record.
RequiredLevelRequiredLevel
None
The required level of the column (None, SystemRequired, ApplicationRequired, or Recommended).
TargetTablesstring[]
The logical names of the tables this lookup can reference. Polymorphic lookups have multiple target tables.
Name: ColumnName
Type: string
Description: The logical name of the column in Dataverse (e.g. 'firstname', 'emailaddress1').
Name: ColumnType
Type: ColumnType
Default: Lookup
Description: Returns Lookup.
Name: Description
Type: string?
Description: The localized description of the column, or null if no description is configured.
Name: DisplayName
Type: string
Description: The localized display name of the column as configured in Dataverse.
Name: IsValidForCreate
Type: bool
Default: False
Description: Indicates whether this column can be set when creating a new record.
Name: IsValidForUpdate
Type: bool
Default: False
Description: Indicates whether this column can be modified when updating an existing record.
Name: RequiredLevel
Type: RequiredLevel
Default: None
Description: The required level of the column (None, SystemRequired, ApplicationRequired, or Recommended).
Name: TargetTables
Type: string[]
Description: The logical names of the tables this lookup can reference. Polymorphic lookups have multiple target tables.