msdyn_upgradeversion Entity Reference

Information about upgrading from one release to the next release

Added by: Solution Upgrade Infrastructure Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/msdyn_upgradeversions
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/msdyn_upgradeversions(msdyn_upgradeversionid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
Retrieve GET [org URI]/api/data/v9.0/msdyn_upgradeversions(msdyn_upgradeversionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/msdyn_upgradeversions
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/msdyn_upgradeversions(msdyn_upgradeversionid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/msdyn_upgradeversions(msdyn_upgradeversionid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName msdyn_upgradeversions
DisplayCollectionName Upgrade Versions
DisplayName Upgrade Version
EntitySetName msdyn_upgradeversions
IsBPFEntity False
LogicalCollectionName msdyn_upgradeversions
LogicalName msdyn_upgradeversion
OwnershipType OrganizationOwned
PrimaryIdAttribute msdyn_upgradeversionid
PrimaryNameAttribute msdyn_summary
SchemaName msdyn_upgradeversion

Writable attributes

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

ImportSequenceNumber

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

msdyn_Finished

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

msdyn_StartingVersion

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

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

msdyn_Status Options

Value Label
100000000 Started
100000001 Success
100000002 Failure

msdyn_summary

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

msdyn_TargetVersion

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

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
Targets msdyn_upgraderun
Type Lookup

msdyn_upgradeversionId

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

OverriddenCreatedOn

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

statecode

Property Value
Description Status of the UpgradeVersion
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 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

statuscode Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

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

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Started
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

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
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

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

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

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

ModifiedOnBehalfBy

Added by: Active Solution Solution

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
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

msdyn_UpgradeRunName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_upgraderunname
MaxLength 4000
RequiredLevel None
Type String

OrganizationId

Added by: Active Solution Solution

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

OrganizationIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Added by: Active Solution Solution

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

One-To-Many Relationships

Listed by SchemaName.

msdyn_upgradeversion_SyncErrors

Added by: System Solution Solution

Same as syncerror entity msdyn_upgradeversion_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_upgradeversion_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_upgradeversion_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation entity msdyn_upgradeversion_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_upgradeversion_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_upgradeversion_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder entity msdyn_upgradeversion_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_upgradeversion_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_upgradeversion_ProcessSession

Added by: System Solution Solution

Same as processsession entity msdyn_upgradeversion_ProcessSession Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_upgradeversion_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_upgradeversion_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure entity msdyn_upgradeversion_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_upgradeversion_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_upgradeversion_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess entity msdyn_upgradeversion_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_upgradeversion_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion

Same as msdyn_upgradestep entity msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion Many-To-One relationship.

Property Value
ReferencingEntity msdyn_upgradestep
ReferencingAttribute msdyn_upgradeversion
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_msdyn_upgradeversion_createdby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradeversion_createdby One-To-Many relationship.

lk_msdyn_upgradeversion_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradeversion_createdonbehalfby One-To-Many relationship.

lk_msdyn_upgradeversion_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradeversion_modifiedby One-To-Many relationship.

lk_msdyn_upgradeversion_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradeversion_modifiedonbehalfby One-To-Many relationship.

organization_msdyn_upgradeversion

Added by: System Solution Solution

See organization Entity organization_msdyn_upgradeversion One-To-Many relationship.

msdyn_msdyn_upgraderun_msdyn_upgradeversion_UpgradeRun

See msdyn_upgraderun Entity msdyn_msdyn_upgraderun_msdyn_upgradeversion_UpgradeRun One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
Microsoft.Dynamics.CRM.msdyn_upgradeversion