Upgrade Step (msdyn_upgradestep) table/entity reference (Microsoft Dynamics 365)

2025-08-29

One step during an upgrade, such as a single method or stored procedure.

Messages

The following table lists the messages for the Upgrade Step (msdyn_upgradestep) 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
`BulkRetain` Event: True	BulkRetain	Learn to use messages with the SDK for .NET
`Create` Event: True	`POST` /msdyn_upgradesteps See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /msdyn_upgradesteps(msdyn_upgradestepid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`PurgeRetainedContent` Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Restore` Event: True	Restore	Learn to use messages with the SDK for .NET
`Retain` Event: True	Retain	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /msdyn_upgradesteps(msdyn_upgradestepid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /msdyn_upgradesteps See Query data	Query data
`RollbackRetain` Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
`SetState` Event: True	`PATCH` /msdyn_upgradesteps(msdyn_upgradestepid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /msdyn_upgradesteps(msdyn_upgradestepid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /msdyn_upgradesteps(msdyn_upgradestepid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest
`ValidateRetentionConfig` Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Upgrade Step (msdyn_upgradestep) table.

Property	Value
DisplayName	Upgrade Step
DisplayCollectionName	Upgrade Steps
SchemaName	`msdyn_upgradestep`
CollectionSchemaName	`msdyn_upgradesteps`
EntitySetName	`msdyn_upgradesteps`
LogicalName	`msdyn_upgradestep`
LogicalCollectionName	`msdyn_upgradesteps`
PrimaryIdAttribute	`msdyn_upgradestepid`
PrimaryNameAttribute	`msdyn_name`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

CreatedOn
ImportSequenceNumber
msdyn_dbversion
msdyn_Details
msdyn_Errors
msdyn_FinishedDate
msdyn_Name
msdyn_Status
msdyn_StepID
msdyn_upgradestepId
msdyn_UpgradeVersion
OverriddenCreatedOn
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

CreatedOn

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

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

msdyn_dbversion

Property	Value
Description	Database version for internal use only
DisplayName	Database Version
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_dbversion`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

msdyn_Details

Property	Value
Description	Diagnostic output from an upgrade step
DisplayName	Details
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_details`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

msdyn_Errors

Property	Value
Description	Error text, if an error occurred during this step
DisplayName	Errors
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_errors`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

msdyn_FinishedDate

Property	Value
Description	Date/time when an upgrade step finished
DisplayName	Finished Date
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_finished`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

msdyn_Name

Property	Value
Description	Name of the method or stored procedure corresponding to an upgrade step
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_name`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

msdyn_Status

Property	Value
Description	Status/outcome of an upgrade step
DisplayName	Step Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_status`
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	100000000
GlobalChoiceName	`msdyn_upgradestatus`

msdyn_Status Choices/Options

Value	Label
100000000	Started
100000001	Success
100000002	Failure

msdyn_StepID

Property	Value
Description
DisplayName	Step ID
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_stepid`
RequiredLevel	ApplicationRequired
Type	Uniqueidentifier

msdyn_upgradestepId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Upgrade Step
IsValidForForm	False
IsValidForRead	True
LogicalName	`msdyn_upgradestepid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_UpgradeVersion

Property	Value
Description	Single-version upgrade that contains this upgrade step
DisplayName	Upgrade Version
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_upgradeversion`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	msdyn_upgradeversion

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

statecode

Property	Value
Description	Status of the UpgradeStep
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`msdyn_upgradestep_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 UpgradeStep
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`msdyn_upgradestep_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
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
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

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

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	None
Type	Lookup
Targets	organization

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_msdyn_upgradestep_createdby
lk_msdyn_upgradestep_createdonbehalfby
lk_msdyn_upgradestep_modifiedby
lk_msdyn_upgradestep_modifiedonbehalfby
msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion
organization_msdyn_upgradestep

lk_msdyn_upgradestep_createdby

One-To-Many Relationship: systemuser lk_msdyn_upgradestep_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_msdyn_upgradestep_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_upgradestep_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_msdyn_upgradestep_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_upgradestep_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_msdyn_upgradestep_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_upgradestep_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`

msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion

One-To-Many Relationship: msdyn_upgradeversion msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion

Property	Value
ReferencedEntity	`msdyn_upgradeversion`
ReferencedAttribute	`msdyn_upgradeversionid`
ReferencingAttribute	`msdyn_upgradeversion`
ReferencingEntityNavigationPropertyName	`msdyn_UpgradeVersion`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `Cascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `Cascade` RollupView: `NoCascade` Share: `Cascade` Unshare: `Cascade`

organization_msdyn_upgradestep

One-To-Many Relationship: organization organization_msdyn_upgradestep

Property	Value
ReferencedEntity	`organization`
ReferencedAttribute	`organizationid`
ReferencingAttribute	`organizationid`
ReferencingEntityNavigationPropertyName	`organizationid`
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.

msdyn_upgradestep_AsyncOperations
msdyn_upgradestep_BulkDeleteFailures
msdyn_upgradestep_MailboxTrackingFolders
msdyn_upgradestep_PrincipalObjectAttributeAccesses
msdyn_upgradestep_ProcessSession
msdyn_upgradestep_SyncErrors

msdyn_upgradestep_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_upgradestep_AsyncOperations

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

msdyn_upgradestep_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_upgradestep_BulkDeleteFailures

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

msdyn_upgradestep_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_upgradestep_MailboxTrackingFolders

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

msdyn_upgradestep_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_upgradestep_PrincipalObjectAttributeAccesses

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

msdyn_upgradestep_ProcessSession

Many-To-One Relationship: processsession msdyn_upgradestep_ProcessSession

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

msdyn_upgradestep_SyncErrors

Many-To-One Relationship: syncerror msdyn_upgradestep_SyncErrors

Property	Value
ReferencingEntity	`syncerror`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`msdyn_upgradestep_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?