Staged optionset (StagedOptionSet) table/entity reference (Microsoft Dataverse)

Stores staged option set metadata to be processed asynchronous.

Messages

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

Properties

The following table lists selected properties for the Staged optionset (StagedOptionSet) table.

Property	Value
DisplayName	Staged optionset
DisplayCollectionName	Staged option set
SchemaName	`StagedOptionSet`
CollectionSchemaName	`StagedOptionSets`
EntitySetName	`stagedoptionsets`
LogicalName	`stagedoptionset`
LogicalCollectionName	`stagedoptionsets`
PrimaryIdAttribute	`stagedoptionsetid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`None`

Writable columns/attributes

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

ComponentState
ImportSequenceNumber
MetadataDescription
Name
OverriddenCreatedOn
OverwriteTime
SolutionId
StagedOptionSetId
StagingExecutionContextId
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

ComponentState

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

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

MetadataDescription

Property	Value
Description	Metadata description of option set.
DisplayName	Metadata Description
IsValidForForm	True
IsValidForRead	True
LogicalName	`metadatadescription`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	8000

Name

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

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 option set.
DisplayName	Overwrite Time
IsValidForForm	True
IsValidForRead	True
LogicalName	`overwritetime`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

SolutionId

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

StagedOptionSetId

Property	Value
Description	Unique identifier for entity instances.
DisplayName	Staged Option Set
IsValidForForm	False
IsValidForRead	True
LogicalName	`stagedoptionsetid`
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 option set.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`stagedoptionset_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 option set.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`stagedoptionset_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_stagedoptionset_createdby
lk_stagedoptionset_createdonbehalfby
lk_stagedoptionset_modifiedby
lk_stagedoptionset_modifiedonbehalfby

lk_stagedoptionset_createdby

One-To-Many Relationship: systemuser lk_stagedoptionset_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_stagedoptionset_createdonbehalfby

One-To-Many Relationship: systemuser lk_stagedoptionset_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_stagedoptionset_modifiedby

One-To-Many Relationship: systemuser lk_stagedoptionset_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_stagedoptionset_modifiedonbehalfby

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

stagedoptionset_AsyncOperations
stagedoptionset_BulkDeleteFailures
stagedoptionset_MailboxTrackingFolders
stagedoptionset_PrincipalObjectAttributeAccesses
stagedoptionset_ProcessSession
stagedoptionset_SyncErrors

stagedoptionset_AsyncOperations

Many-To-One Relationship: asyncoperation stagedoptionset_AsyncOperations

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

stagedoptionset_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure stagedoptionset_BulkDeleteFailures

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

stagedoptionset_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder stagedoptionset_MailboxTrackingFolders

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

stagedoptionset_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess stagedoptionset_PrincipalObjectAttributeAccesses

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

stagedoptionset_ProcessSession

Many-To-One Relationship: processsession stagedoptionset_ProcessSession

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

stagedoptionset_SyncErrors

Many-To-One Relationship: syncerror stagedoptionset_SyncErrors

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

Feedback

Was this page helpful?

Last updated on 2025-11-01