Install History (mspcat_InstallHistory) table/entity reference

2024-11-06

Contains record of installations and their status

Messages

The following table lists the messages for the Install History (mspcat_InstallHistory) 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
`Assign` Event: True	`PATCH` /mspcat_installhistories(mspcat_installhistoryid) Update the `ownerid` property.	AssignRequest
`Create` Event: True	`POST` /mspcat_installhistories See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /mspcat_installhistories(mspcat_installhistoryid) See Delete	Delete records
`GrantAccess` Event: True	GrantAccess	GrantAccessRequest
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`ModifyAccess` Event: True	ModifyAccess	ModifyAccessRequest
`Retrieve` Event: True	`GET` /mspcat_installhistories(mspcat_installhistoryid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /mspcat_installhistories See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`RetrieveSharedPrincipalsAndAccess` Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
`RevokeAccess` Event: True	RevokeAccess	RevokeAccessRequest
`SetState` Event: True	`PATCH` /mspcat_installhistories(mspcat_installhistoryid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /mspcat_installhistories(mspcat_installhistoryid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /mspcat_installhistories(mspcat_installhistoryid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the Install History (mspcat_InstallHistory) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Install History (mspcat_InstallHistory) table.

Property	Value
DisplayName	Install History
DisplayCollectionName	Install Histories
SchemaName	`mspcat_InstallHistory`
CollectionSchemaName	`mspcat_InstallHistories`
EntitySetName	`mspcat_installhistories`
LogicalName	`mspcat_installhistory`
LogicalCollectionName	`mspcat_installhistories`
PrimaryIdAttribute	`mspcat_installhistoryid`
PrimaryNameAttribute	`mspcat_deploymentname`
TableType	`Standard`
OwnershipType	`UserOwned`

Writable columns/attributes

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

ImportSequenceNumber
mspcat_CatalogItem
mspcat_DeploymentName
mspcat_EnvironmentUrl
mspcat_InstallHistoryId
mspcat_OperationId
mspcat_OrganizationId
mspcat_Package
mspcat_Publisher
mspcat_RequestingUser
mspcat_Settings
mspcat_StatusMessage
mspcat_TemplateSuffixId
OverriddenCreatedOn
OwnerId
OwnerIdType
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

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

mspcat_CatalogItem

Property	Value
Description	Catalog Item that this package was associated to
DisplayName	Catalog Item
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_catalogitem`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	mspcat_applications

mspcat_DeploymentName

Property	Value
Description	Descriptive Name of the Install, Built from Application Name, package unique name , Instance ID
DisplayName	Deployment Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_deploymentname`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

mspcat_EnvironmentUrl

Property	Value
Description	URL of the environment where this catalog item was installed
DisplayName	Environment Url
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_environmenturl`
RequiredLevel	ApplicationRequired
Type	String
Format	Url
FormatName	Url
ImeMode	Auto
IsLocalizable	False
MaxLength	500

mspcat_InstallHistoryId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Install History
IsValidForForm	False
IsValidForRead	True
LogicalName	`mspcat_installhistoryid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

mspcat_OperationId

Property	Value
Description	Id used by the deployment system to track the install.
DisplayName	Operation Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_operationid`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	40

mspcat_OrganizationId

Property	Value
Description	ID of the organization that this install was run against.
DisplayName	Organization Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_organizationid`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	40

mspcat_Package

Property	Value
Description	Package Deployed
DisplayName	Package
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_package`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	mspcat_packages

mspcat_Publisher

Property	Value
Description	Publisher who owns this Catalog Item
DisplayName	Publisher
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_publisher`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	mspcat_publisher

mspcat_RequestingUser

Property	Value
Description	User that Requested the Install
DisplayName	Requesting User
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_requestinguser`
RequiredLevel	None
Type	Lookup
Targets	systemuser

mspcat_Settings

Property	Value
Description	Deployment Settings Included with this Install request.
DisplayName	Settings
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_settings`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	400000

mspcat_StatusMessage

Property	Value
Description	Status Message associated with this install
DisplayName	Status Message
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_statusmessage`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

mspcat_TemplateSuffixId

Property	Value
Description	This is the suffix id assigned to components created by the template deployment.
DisplayName	Template Suffix Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_templatesuffixid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	15

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

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	`ownerid`
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridtype`
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the Install History
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`mspcat_installhistory_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 Install History
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`mspcat_installhistory_statuscode`

statuscode Choices/Options

Value	Details
1	Label: Requested State:0 TransitionData: `<allowedtransitions xmlns="http://schemas.microsoft.com/crm/2009/WebServices"><allowedtransition sourcestatusid="1" tostatusid="526430003" /><allowedtransition sourcestatusid="1" tostatusid="526430002" /><allowedtransition sourcestatusid="1" tostatusid="2" /><allowedtransition sourcestatusid="1" tostatusid="526430004" /><allowedtransition sourcestatusid="1" tostatusid="526430001" /></allowedtransitions>`
2	Label: Inactive State:1 TransitionData: None
526430001	Label: Pending State:0 TransitionData: `<allowedtransitions xmlns="http://schemas.microsoft.com/crm/2009/WebServices"><allowedtransition sourcestatusid="526430001" tostatusid="526430003" /><allowedtransition sourcestatusid="526430001" tostatusid="526430004" /><allowedtransition sourcestatusid="526430001" tostatusid="526430002" /><allowedtransition sourcestatusid="526430001" tostatusid="2" /></allowedtransitions>`
526430002	Label: In Progress State:0 TransitionData: `<allowedtransitions xmlns="http://schemas.microsoft.com/crm/2009/WebServices"><allowedtransition sourcestatusid="526430002" tostatusid="526430003" /><allowedtransition sourcestatusid="526430002" tostatusid="526430004" /><allowedtransition sourcestatusid="526430002" tostatusid="2" /></allowedtransitions>`
526430003	Label: Completed State:1 TransitionData: None
526430004	Label: Failed 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
mspcat_DeploymentLogFile
mspcat_DeploymentLogFile_Name
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
OwningTeam
OwningUser
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

mspcat_DeploymentLogFile

Property	Value
Description	Log file generated by the deployment operation
DisplayName	Deployment Log File
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_deploymentlogfile`
RequiredLevel	None
Type	File
MaxSizeInKB	56768

mspcat_DeploymentLogFile_Name

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`mspcat_deploymentlogfile_name`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Disabled
IsLocalizable	False
MaxLength	200

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridyominame`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	`owningbusinessunit`
RequiredLevel	None
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	`owningteam`
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	`owninguser`
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.

mspcat_mspcat_installhistory_CatalogItem_mspcat_
mspcat_mspcat_installhistory_Package_mspcat_pack
mspcat_mspcat_installhistory_Publisher_mspcat_pu

mspcat_mspcat_installhistory_CatalogItem_mspcat_

One-To-Many Relationship: mspcat_applications mspcat_mspcat_installhistory_CatalogItem_mspcat_

Property	Value
ReferencedEntity	`mspcat_applications`
ReferencedAttribute	`mspcat_applicationsid`
ReferencingAttribute	`mspcat_catalogitem`
ReferencingEntityNavigationPropertyName	`mspcat_CatalogItem`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

mspcat_mspcat_installhistory_Package_mspcat_pack

One-To-Many Relationship: mspcat_packages mspcat_mspcat_installhistory_Package_mspcat_pack

Property	Value
ReferencedEntity	`mspcat_packages`
ReferencedAttribute	`mspcat_packagesid`
ReferencingAttribute	`mspcat_package`
ReferencingEntityNavigationPropertyName	`mspcat_Package`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

mspcat_mspcat_installhistory_Publisher_mspcat_pu

One-To-Many Relationship: mspcat_publisher mspcat_mspcat_installhistory_Publisher_mspcat_pu

Property	Value
ReferencedEntity	`mspcat_publisher`
ReferencedAttribute	`mspcat_publisherid`
ReferencingAttribute	`mspcat_publisher`
ReferencingEntityNavigationPropertyName	`mspcat_Publisher`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

mspcat_installhistory_mspcat_InstallActivities

Many-To-One Relationship: mspcat_installactivity mspcat_installhistory_mspcat_InstallActivities

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