msdyn_upgradestep Entity Reference

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

Added by: Solution Upgrade Infrastructure Solution

Messages

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

Entity Properties

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

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_dbversion

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

msdyn_Details

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

msdyn_Errors

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

msdyn_FinishedDate

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

msdyn_Name

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

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

msdyn_Status 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
IsValidForUpdate False
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
Targets msdyn_upgradeversion
Type Lookup

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 UpgradeStep
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 UpgradeStep
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_UpgradeVersionName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_upgradeversionname
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_upgradestep_SyncErrors

Added by: System Solution Solution

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

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

msdyn_upgradestep_AsyncOperations

Added by: System Solution Solution

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

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

msdyn_upgradestep_MailboxTrackingFolders

Added by: System Solution Solution

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

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

msdyn_upgradestep_ProcessSession

Added by: System Solution Solution

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

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

msdyn_upgradestep_BulkDeleteFailures

Added by: System Solution Solution

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

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

msdyn_upgradestep_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

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

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

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_upgradestep_createdby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradestep_createdby One-To-Many relationship.

lk_msdyn_upgradestep_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradestep_createdonbehalfby One-To-Many relationship.

lk_msdyn_upgradestep_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradestep_modifiedby One-To-Many relationship.

lk_msdyn_upgradestep_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_upgradestep_modifiedonbehalfby One-To-Many relationship.

organization_msdyn_upgradestep

Added by: System Solution Solution

See organization Entity organization_msdyn_upgradestep One-To-Many relationship.

msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion

See msdyn_upgradeversion Entity msdyn_msdyn_upgradeversion_msdyn_upgradestep_UpgradeVersion One-To-Many relationship.

See also

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