Upgrade Version (msdyn_upgradeversion) table/entity reference (Microsoft Dynamics 365)

Article
2025-02-08

Information about upgrading from one release to the next release

Messages

The following table lists the messages for the Upgrade Version (msdyn_upgradeversion) 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_upgradeversions See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /msdyn_upgradeversions(msdyn_upgradeversionid) 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_upgradeversions(msdyn_upgradeversionid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /msdyn_upgradeversions See Query data	Query data
`RollbackRetain` Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
`SetState` Event: True	`PATCH` /msdyn_upgradeversions(msdyn_upgradeversionid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /msdyn_upgradeversions(msdyn_upgradeversionid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /msdyn_upgradeversions(msdyn_upgradeversionid) 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 Version (msdyn_upgradeversion) table.

Property	Value
DisplayName	Upgrade Version
DisplayCollectionName	Upgrade Versions
SchemaName	`msdyn_upgradeversion`
CollectionSchemaName	`msdyn_upgradeversions`
EntitySetName	`msdyn_upgradeversions`
LogicalName	`msdyn_upgradeversion`
LogicalCollectionName	`msdyn_upgradeversions`
PrimaryIdAttribute	`msdyn_upgradeversionid`
PrimaryNameAttribute	`msdyn_summary`
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_Finished
msdyn_StartingVersion
msdyn_Status
msdyn_summary
msdyn_TargetVersion
msdyn_UpgradeRun
msdyn_upgradeversionId
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_Finished

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

msdyn_StartingVersion

Property	Value
Description	Version that was installed before a single-version upgrade
DisplayName	StartingVersion
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_startingversion`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_Status

Property	Value
Description	Status/outcome of a single-version upgrade
DisplayName	Upgrade Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_status`
RequiredLevel	None
Type	Picklist
DefaultFormValue	100000000
GlobalChoiceName	`msdyn_upgradestatus`

msdyn_Status Choices/Options

Value	Label
100000000	Started
100000001	Success
100000002	Failure

msdyn_summary

Property	Value
Description	Summary of a single-version upgrade
DisplayName	Summary
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_summary`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

msdyn_TargetVersion

Property	Value
Description	Version that will be achieved by a single-version upgrade
DisplayName	TargetVersion
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_targetversion`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_UpgradeRun

Property	Value
Description	Package deployer run that invoked a single-version upgrade
DisplayName	UpgradeRun
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_upgraderun`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	msdyn_upgraderun

msdyn_upgradeversionId

Property	Value
Description	Unique identifier for entity instances
DisplayName	UpgradeVersion
IsValidForForm	False
IsValidForRead	True
LogicalName	`msdyn_upgradeversionid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

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 UpgradeVersion
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`msdyn_upgradeversion_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 UpgradeVersion
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`msdyn_upgradeversion_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_upgradeversion_createdby
lk_msdyn_upgradeversion_createdonbehalfby
lk_msdyn_upgradeversion_modifiedby
lk_msdyn_upgradeversion_modifiedonbehalfby
msdyn_msdyn_upgraderun_msdyn_upgradeversion_UpgradeRun
organization_msdyn_upgradeversion

lk_msdyn_upgradeversion_createdby

One-To-Many Relationship: systemuser lk_msdyn_upgradeversion_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_upgradeversion_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_upgradeversion_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_upgradeversion_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_upgradeversion_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_upgradeversion_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_upgradeversion_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_upgraderun_msdyn_upgradeversion_UpgradeRun

One-To-Many Relationship: msdyn_upgraderun msdyn_msdyn_upgraderun_msdyn_upgradeversion_UpgradeRun

Property	Value
ReferencedEntity	`msdyn_upgraderun`
ReferencedAttribute	`msdyn_upgraderunid`
ReferencingAttribute	`msdyn_upgraderun`
ReferencingEntityNavigationPropertyName	`msdyn_UpgradeRun`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `Cascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `Cascade` RollupView: `NoCascade` Share: `Cascade` Unshare: `Cascade`

organization_msdyn_upgradeversion

One-To-Many Relationship: organization organization_msdyn_upgradeversion

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_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion
msdyn_upgradeversion_AsyncOperations
msdyn_upgradeversion_BulkDeleteFailures
msdyn_upgradeversion_MailboxTrackingFolders
msdyn_upgradeversion_PrincipalObjectAttributeAccesses
msdyn_upgradeversion_ProcessSession
msdyn_upgradeversion_SyncErrors

msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion

Many-To-One Relationship: msdyn_upgradestep msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion

Property	Value
ReferencingEntity	`msdyn_upgradestep`
ReferencingAttribute	`msdyn_upgradeversion`
ReferencedEntityNavigationPropertyName	`msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

msdyn_upgradeversion_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_upgradeversion_AsyncOperations

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

msdyn_upgradeversion_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_upgradeversion_BulkDeleteFailures

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

msdyn_upgradeversion_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_upgradeversion_MailboxTrackingFolders

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

msdyn_upgradeversion_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_upgradeversion_PrincipalObjectAttributeAccesses

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

msdyn_upgradeversion_ProcessSession

Many-To-One Relationship: processsession msdyn_upgradeversion_ProcessSession

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

msdyn_upgradeversion_SyncErrors

Many-To-One Relationship: syncerror msdyn_upgradeversion_SyncErrors

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

Share via