EntityKey table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Messages

Message Web API Operation SDK Assembly
RetrieveMultiple GET [org URI]/api/data/v9.0/entitykeys
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Properties

Property Value
CollectionSchemaName EntityKeys
DisplayCollectionName Entity Keys
DisplayName Entity Key
EntitySetName entitykeys
IsBPFEntity False
LogicalCollectionName entitykeys
LogicalName entitykey
OwnershipType None
PrimaryIdAttribute entitykeyid
PrimaryNameAttribute logicalname
SchemaName EntityKey

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

EntityKeyId

Property Value
Description Unique identifier of the entity key.
DisplayName Entity Key
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName entitykeyid
RequiredLevel SystemRequired
Type Uniqueidentifier

LogicalName

Property Value
Description The logical name of this Entity Key.
DisplayName Logical Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName logicalname
MaxLength 128
RequiredLevel SystemRequired
Type String

Name

Property Value
Description The name of this Entity Key.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 128
RequiredLevel SystemRequired
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

IsSecondaryKey

Added by: Metadata Extension Solution

Property Value
Description Is the attribute secondary key.
DisplayName IsSecondaryKey
IsValidForForm False
IsValidForRead True
LogicalName issecondarykey
RequiredLevel None
Type Boolean

IsSecondaryKey Choices/Options

Value Label Description

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

See also

About the table reference
Web API Reference
entitykey EntityType