Relationship Entity (Relationship) 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 /relationships See Query Data	RetrieveMultipleRequest or RetrieveMultiple

Properties

Property	Value
CollectionSchemaName	Relationships
DisplayCollectionName	Relationship Entities
DisplayName	Relationship Entity
EntitySetName	relationships
IsBPFEntity	False
LogicalCollectionName	relationships
LogicalName	relationship
OwnershipType	None
PrimaryIdAttribute	relationshipid
PrimaryNameAttribute	name
SchemaName	Relationship

Writable columns/attributes

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

• EntityKeyId
• Name
• RelationshipId

EntityKeyId

Property	Value
Description	Referenced Entity's Alternate Key
DisplayName	Entity Key Id
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	entitykeyid
RequiredLevel	None
Type	Uniqueidentifier

Name

Property	Value
Description	Name of the relationship.
DisplayName	Relationship Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	name
MaxLength	255
RequiredLevel	SystemRequired
Type	String

RelationshipId

Property	Value
Description	Unique identifier of the entity relationship.
DisplayName	Relationship Id
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	relationshipid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CascadeArchive
• ComponentState
• IsRelationshipAttributeDenormalized
• OverwriteTime
• SolutionId
• VersionNumber

CascadeArchive

Added by: Metadata Extension Solution

Property	Value
Description	Cascade archive setting
DisplayName	Cascade archive setting
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	cascadearchive
MaxValue
MinValue
RequiredLevel	SystemRequired
Type	Integer

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

IsRelationshipAttributeDenormalized

Added by: Metadata Extension Solution

Property	Value
Description	Is the relationship attribute denormalized.
DisplayName	IsRelationshipAttributeDenormalized
IsValidForForm	False
IsValidForRead	True
LogicalName	isrelationshipattributedenormalized
RequiredLevel	None
Type	Boolean

IsRelationshipAttributeDenormalized 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

VersionNumber

Added by: Metadata Extension Solution

Property	Value
Description	The version number of this relationship.
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

One-To-Many Relationships

Listed by SchemaName.

relationship_relationshipattribute

Added by: Metadata Extension Solution

Same as the relationship_relationshipattribute many-to-one relationship for the relationshipattribute table/entity.

Property	Value
ReferencingEntity	relationshipattribute
ReferencingAttribute	relationshipid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	relationship_relationshipattribute
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order: 10000
CascadeConfiguration	Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade

See also

Dataverse table/entity reference
Web API Reference
relationship EntityType