Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Messages
The following table lists the messages for the Relationship Entity (Relationship) table. Messages represent operations that can be performed on the table. They may also be events.
| Name Is Event? |
Web API Operation | SDK for .NET |
|---|---|---|
AssociateEvent: True |
Associate records | Associate records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
RetrieveMultipleEvent: False |
GET /relationshipsSee Query data |
Query data |
Properties
The following table lists selected properties for the Relationship Entity (Relationship) table.
| Property | Value |
|---|---|
| DisplayName | Relationship Entity |
| DisplayCollectionName | Relationship Entities |
| SchemaName | Relationship |
| CollectionSchemaName | Relationships |
| EntitySetName | relationships |
| LogicalName | relationship |
| LogicalCollectionName | relationships |
| PrimaryIdAttribute | relationshipid |
| PrimaryNameAttribute | name |
| TableType | Standard |
| OwnershipType | None |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
EntityKeyId
| Property | Value |
|---|---|
| Description | Referenced Entity's Alternate Key |
| DisplayName | Entity Key Id |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | entitykeyid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
Name
| Property | Value |
|---|---|
| Description | Name of the relationship. |
| DisplayName | Relationship Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 255 |
RelationshipId
| Property | Value |
|---|---|
| Description | Unique identifier of the entity relationship. |
| DisplayName | Relationship Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | relationshipid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- CascadeArchive
- ComponentState
- IsRelationshipAttributeDenormalized
- OverwriteTime
- SolutionId
- VersionNumber
CascadeArchive
| Property | Value |
|---|---|
| Description | Cascade archive setting |
| DisplayName | Cascade archive setting |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | cascadearchive |
| RequiredLevel | SystemRequired |
| Type | Integer |
| MaxValue | |
| MinValue |
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | -1 |
| GlobalChoiceName | componentstate |
ComponentState Choices/Options
| Value | Label |
|---|---|
| 0 | Published |
| 1 | Unpublished |
| 2 | Deleted |
| 3 | Deleted Unpublished |
IsRelationshipAttributeDenormalized
| Property | Value |
|---|---|
| Description | Is the relationship attribute denormalized. |
| DisplayName | IsRelationshipAttributeDenormalized |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isrelationshipattributedenormalized |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | _relationship_isrelationshipattributedenormalized |
| DefaultValue | False |
| True Label | |
| False Label |
OverwriteTime
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateOnly |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
VersionNumber
| Property | Value |
|---|---|
| Description | The version number of this relationship. |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| RequiredLevel | None |
| Type | BigInt |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
relationship_relationshipattribute
Many-To-One Relationship: relationshipattribute relationship_relationshipattribute
| Property | Value |
|---|---|
| ReferencingEntity | relationshipattribute |
| ReferencingAttribute | relationshipid |
| ReferencedEntityNavigationPropertyName | relationship_relationshipattribute |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
relationship