Staged Entity (StagedEntity) table/entity reference (Microsoft Dataverse)

Stores staged entity metadata to be processed before fully created.

Messages

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

Properties

The following table lists selected properties for the Staged Entity (StagedEntity) table.

Property	Value
DisplayName	Staged Entity
DisplayCollectionName	Staged Entities
SchemaName	StagedEntity
CollectionSchemaName	StagedEntities
EntitySetName	stagedentities
LogicalName	stagedentity
LogicalCollectionName	stagedentities
PrimaryIdAttribute	stagedentityid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	None

Writable columns/attributes

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

• CollectionName
• DataproviderId
• DatasourceId
• EntityDescription
• EntitySetName
• ExternalCollectionName
• ExternalName
• ImportSequenceNumber
• LogicalCollectionName
• LogicalName
• Name
• OriginalLocalizedCollectionName
• OriginalLocalizedDescription
• OriginalLocalizedName
• OverriddenCreatedOn
• PhysicalName
• StagedEntityId
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

CollectionName

Property	Value
Description	The collection name of the staged entity.
DisplayName	Collection Name
IsValidForForm	True
IsValidForRead	True
LogicalName	collectionname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

DataproviderId

Property	Value
Description	The ID of the data provider for virtual entity.
DisplayName	Dataprovider ID
IsValidForForm	True
IsValidForRead	True
LogicalName	dataproviderid
RequiredLevel	None
Type	Uniqueidentifier

DatasourceId

Property	Value
Description	The ID of the data source for virtual entity.
DisplayName	Datasource ID
IsValidForForm	True
IsValidForRead	True
LogicalName	datasourceid
RequiredLevel	None
Type	Uniqueidentifier

EntityDescription

Property	Value
Description	The entity decription with properties for delta update
DisplayName	EntityDescription
IsValidForForm	True
IsValidForRead	True
LogicalName	entitydescription
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	8000

EntitySetName

Property	Value
Description	The entity set name of the staged entity.
DisplayName	Entity Set Name
IsValidForForm	True
IsValidForRead	True
LogicalName	entitysetname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

ExternalCollectionName

Property	Value
Description	The external collection name of the staged entity for VT scenario.
DisplayName	External Collection Name
IsValidForForm	True
IsValidForRead	True
LogicalName	externalcollectionname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

ExternalName

Property	Value
Description	The external name for virtual entity.
DisplayName	ExternalName
IsValidForForm	True
IsValidForRead	True
LogicalName	externalname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

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

LogicalCollectionName

Property	Value
Description	The logical collection name of the staged entity.
DisplayName	Logical Collection Name
IsValidForForm	True
IsValidForRead	True
LogicalName	logicalcollectionname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

LogicalName

Property	Value
Description	The logical name of the staged entity.
DisplayName	Logical Name
IsValidForForm	True
IsValidForRead	True
LogicalName	logicalname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

Name

Property	Value
Description	The name of the staged entity.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

OriginalLocalizedCollectionName

Property	Value
Description	The original localized collection name of the staged entity.
DisplayName	Original Localized Collection Name
IsValidForForm	True
IsValidForRead	True
LogicalName	originallocalizedcollectioname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

OriginalLocalizedDescription

Property	Value
Description	The localized description of the entity.
DisplayName	OriginalLocalizedDescription
IsValidForForm	True
IsValidForRead	True
LogicalName	originallocalizedescription
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	8000

OriginalLocalizedName

Property	Value
Description	The original localized name of the staged entity.
DisplayName	Original Localized Name
IsValidForForm	True
IsValidForRead	True
LogicalName	originallocalizedname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

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

PhysicalName

Property	Value
Description	The physical name of the staged entity.
DisplayName	Physical Name
IsValidForForm	True
IsValidForRead	True
LogicalName	physicalname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

StagedEntityId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Entity identifier
IsValidForForm	False
IsValidForRead	True
LogicalName	stagedentityid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

statecode

Property	Value
Description	Status of the Staged Entity
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	stagedentity_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 Entity
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	stagedentity_statuscode

statuscode Choices/Options

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

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
• CreatedOn
• CreatedOnBehalfBy
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• VersionNumber

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

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_stagedentity_createdby
• lk_stagedentity_createdonbehalfby
• lk_stagedentity_modifiedby
• lk_stagedentity_modifiedonbehalfby

lk_stagedentity_createdby

One-To-Many Relationship: systemuser lk_stagedentity_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_stagedentity_createdonbehalfby

One-To-Many Relationship: systemuser lk_stagedentity_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_stagedentity_modifiedby

One-To-Many Relationship: systemuser lk_stagedentity_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_stagedentity_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_stagedentity_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.

• stagedentity_AsyncOperations
• stagedentity_BulkDeleteFailures
• stagedentity_MailboxTrackingFolders
• stagedentity_PrincipalObjectAttributeAccesses
• stagedentity_ProcessSession
• stagedentity_SyncErrors

stagedentity_AsyncOperations

Many-To-One Relationship: asyncoperation stagedentity_AsyncOperations

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

stagedentity_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure stagedentity_BulkDeleteFailures

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

stagedentity_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder stagedentity_MailboxTrackingFolders

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

stagedentity_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess stagedentity_PrincipalObjectAttributeAccesses

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

stagedentity_ProcessSession

Many-To-One Relationship: processsession stagedentity_ProcessSession

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

stagedentity_SyncErrors

Many-To-One Relationship: syncerror stagedentity_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	stagedentity_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
stagedentity