Edit

Share via

Staged relationship (StagedRelationship) table/entity reference (Microsoft Dataverse)

Stores staged replationship metadata to be processed asynchronous.

Messages

The following table lists the messages for the Staged relationship (StagedRelationship) 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
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /stagedrelationships
See Create		 Create records
Delete
Event: True		 DELETE /stagedrelationships(stagedrelationshipid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
Retrieve
Event: True		 GET /stagedrelationships(stagedrelationshipid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /stagedrelationships
See Query data		 Query data
Update
Event: True		 PATCH /stagedrelationships(stagedrelationshipid)
See Update		 Update records
Upsert
Event: False		 PATCH /stagedrelationships(stagedrelationshipid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Staged relationship (StagedRelationship) table.

Property Value
DisplayName Staged relationship
DisplayCollectionName Staged relationships
SchemaName StagedRelationship
CollectionSchemaName StagedRelationships
EntitySetName stagedrelationships
LogicalName stagedrelationship
LogicalCollectionName stagedrelationships
PrimaryIdAttribute stagedrelationshipid
PrimaryNameAttribute name
TableType Standard
OwnershipType None

Writable columns/attributes

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

CascadeArchive

Property Value
Description Cascade archive behavior.
DisplayName Cascade Archive
IsValidForForm True
IsValidForRead True
LogicalName cascadearchive
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeAssign

Property Value
Description Cascade assign behavior.
DisplayName Cascade Assign
IsValidForForm True
IsValidForRead True
LogicalName cascadeassign
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeDelete

Property Value
Description Cascade delete behavior.
DisplayName Cascade Delete
IsValidForForm True
IsValidForRead True
LogicalName cascadedelete
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeLinkMask

Property Value
Description Cascade link mask value.
DisplayName Cascade Link Mask
IsValidForForm True
IsValidForRead True
LogicalName cascadelinkmask
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

CascadeMerge

Property Value
Description Cascade merge behavior.
DisplayName Cascade Merge
IsValidForForm True
IsValidForRead True
LogicalName cascademerge
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeReparent

Property Value
Description Cascade reparent behavior.
DisplayName Cascade Reparent
IsValidForForm True
IsValidForRead True
LogicalName cascadereparent
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeRollupView

Property Value
Description Cascade rollup view behavior.
DisplayName Cascade Rollup View
IsValidForForm True
IsValidForRead True
LogicalName cascaderollupview
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeShare

Property Value
Description Cascade share behavior.
DisplayName Cascade Share
IsValidForForm True
IsValidForRead True
LogicalName cascadeshare
RequiredLevel None
Type Integer
MaxValue
MinValue

CascadeUnShare

Property Value
Description Cascade unshare behavior.
DisplayName Cascade UnShare
IsValidForForm True
IsValidForRead True
LogicalName cascadeunshare
RequiredLevel None
Type Integer
MaxValue
MinValue

ComponentState

Property Value
Description Solution component state of relationship.
DisplayName Component State
IsValidForForm True
IsValidForRead True
LogicalName componentstate
RequiredLevel None
Type Integer
MaxValue
MinValue

EntityKeyId

Property Value
Description Identifier of the entity key.
DisplayName Entity Key Id
IsValidForForm True
IsValidForRead True
LogicalName entitykeyid
RequiredLevel None
Type Uniqueidentifier

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsCustomRelationship

Property Value
Description Indicates if the relationship is custom.
DisplayName Is Custom Relationship
IsValidForForm True
IsValidForRead True
LogicalName iscustomrelationship
RequiredLevel None
Type Boolean
GlobalChoiceName _stagedrelationship_iscustomrelationship
DefaultValue False
True Label
False Label

IsLogical

Property Value
Description Indicates if the relationship is logical.
DisplayName Is Logical
IsValidForForm True
IsValidForRead True
LogicalName islogical
RequiredLevel None
Type Boolean
GlobalChoiceName _stagedrelationship_islogical
DefaultValue False
True Label
False Label

IsRelationshipAttributeDenormalized

Property Value
Description Indicates if the relationship attribute is denormalized.
DisplayName Is Relationship Attribute Denormalized
IsValidForForm True
IsValidForRead True
LogicalName isrelationshipattributedenormalized
RequiredLevel None
Type Boolean
GlobalChoiceName _stagedrelationship_isrelationshipattributedenormalized
DefaultValue False
True Label
False Label

IsValidForAdvancedFind

Property Value
Description Indicates if the relationship is valid for advanced find.
DisplayName Is Valid For Advanced Find
IsValidForForm True
IsValidForRead True
LogicalName isvalidforadvancedfind
RequiredLevel None
Type Boolean
GlobalChoiceName _stagedrelationship_isvalidforadvancedfind
DefaultValue False
True Label
False Label

Name

Property Value
Description The name of the relationship.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 255

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

OverwriteTime

Property Value
Description Overwrite time of the solution component relationship.
DisplayName Overwrite Time
IsValidForForm True
IsValidForRead True
LogicalName overwritetime
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Auto
SourceTypeMask 0

RecordId

Property Value
Description Record identifier.
DisplayName Record Id
IsValidForForm True
IsValidForRead True
LogicalName recordid
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

ReferencedAttributeId

Property Value
Description Identifier of the referenced attribute.
DisplayName Referenced Attribute Id
IsValidForForm True
IsValidForRead True
LogicalName referencedattributeid
RequiredLevel None
Type Uniqueidentifier

ReferencedEntityId

Property Value
Description Identifier of the referenced entity.
DisplayName Referenced Entity Id
IsValidForForm True
IsValidForRead True
LogicalName referencedentityid
RequiredLevel None
Type Uniqueidentifier

ReferencingAttributeId

Property Value
Description Identifier of the referencing attribute.
DisplayName Referencing Attribute Id
IsValidForForm True
IsValidForRead True
LogicalName referencingattributeid
RequiredLevel None
Type Uniqueidentifier

ReferencingEntityId

Property Value
Description Identifier of the referencing entity.
DisplayName Referencing Entity Id
IsValidForForm True
IsValidForRead True
LogicalName referencingentityid
RequiredLevel None
Type Uniqueidentifier

RelationshipRowId

Property Value
Description Identifier of the relationship row.
DisplayName Relationship Row Id
IsValidForForm True
IsValidForRead True
LogicalName relationshiprowid
RequiredLevel None
Type Uniqueidentifier

RelationshipType

Property Value
Description Type of the relationship.
DisplayName Relationship Type
IsValidForForm True
IsValidForRead True
LogicalName relationshiptype
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

SolutionId

Property Value
Description Identifier of the solution that contains relationship.
DisplayName Solution Id
IsValidForForm True
IsValidForRead True
LogicalName solutionid
RequiredLevel None
Type Uniqueidentifier

StagedRelationshipId

Property Value
Description Unique identifier for entity instances.
DisplayName Staged Relationship
IsValidForForm False
IsValidForRead True
LogicalName stagedrelationshipid
RequiredLevel SystemRequired
Type Uniqueidentifier

StagingExecutionContextId

Property Value
Description A unique identifier used to tie together all objects staged within the same transaction.
DisplayName Staging Execution Context Id
IsValidForForm True
IsValidForRead True
LogicalName stagingexecutioncontextid
RequiredLevel None
Type Uniqueidentifier

statecode

Property Value
Description Status of the staged relationship.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName stagedrelationship_statecode

statecode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: Inactive

statuscode

Property Value
Description Reason for the status of the staged relationship.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName stagedrelationship_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

SupportingSolutionId

Property Value
Description Identifier of the supporting solution.
DisplayName Supporting Solution Id
IsValidForForm True
IsValidForRead True
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Read-only columns/attributes

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

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

IntroducedVersion

Property Value
Description The version in which this relationship was introduced.
DisplayName Introduced Version
IsValidForForm False
IsValidForRead True
LogicalName introducedversion
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 48

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_stagedrelationship_createdby

One-To-Many Relationship: systemuser lk_stagedrelationship_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_stagedrelationship_createdonbehalfby

One-To-Many Relationship: systemuser lk_stagedrelationship_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_stagedrelationship_modifiedby

One-To-Many Relationship: systemuser lk_stagedrelationship_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_stagedrelationship_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_stagedrelationship_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

stagedrelationship_AsyncOperations

Many-To-One Relationship: asyncoperation stagedrelationship_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName stagedrelationship_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

stagedrelationship_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure stagedrelationship_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName stagedrelationship_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

stagedrelationship_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder stagedrelationship_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName stagedrelationship_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

stagedrelationship_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess stagedrelationship_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName stagedrelationship_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

stagedrelationship_ProcessSession

Many-To-One Relationship: processsession stagedrelationship_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName stagedrelationship_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

stagedrelationship_SyncErrors

Many-To-One Relationship: syncerror stagedrelationship_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName stagedrelationship_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference

  • Last updated on