UpdateType

This method is used to update entities of a custom type to a different type version.

Parameters

Parameter Description / Help message in CLI
mt maintype

The main type of the entities you want to update.

Can be one of the following:

  • Application
  • Artifact
  • ArtifactSource
  • Component
  • DeploymentTarget
  • Environment
  • Package
  • PackageDependency
  • Reservation
  • StackProvider
  • StackTemplate
  • Workflow
ct customtype The custom type of the entities you want to update.
version typeversion The current type version of the entities.
toversion typeversion The type versions to update the entities to. If missing, the current active type version is used.
where condition Zero to many conditions (enclosed with " ") that are used to filter the entities before updating them. The format of a condition is: "[propertyname] [operator] '[value]'", for example "system_name eq 'ARA'"
whatif Makes a dry run and only prints what will happen, but does not actually do the change.
force Forces the conversion of entities which cannot be converted safely.
verbose Outputs a detailed report of what's happening during conversion.

The conversation is done based on the following rules:

Entity Condition Behavior Error Message
Custom Property Exactly the same definition in previous version and the new version. The value is converted 1:1.  
The property does not exist in the new version. The entity will not be converted unless the force flag is set. The property \[propertyname] does not exist in the new version. Use the force flag to drop the property.
The property type of the new version is Identity but is not Identity in the previous version. If the property is not empty, conversation will fail unless the force flag is set. The property \[propertyname] cannot be safely converted to an identity property. The force flag clears the value.
The property is of type password in the previous version but not in the new version. If the current value is empty, it is converted. If the value is not empty, the entity will not be converted unless the force flag is set. The property \[propertyname] cannot be converted because the new type is not protected. The force flag resets the password to an empty value.
The property has a different type in the new version. The system will try to convert the value to the new property type and fail if this is not possible. The property \[propertyname] of type \[typename] cannot be converted to the new property type \[new type of property]. The force flag resets the value to \[default value of the new type].
The property \[propertyname] of type \[typename] cannot be converted to the new property type \[new type of property]. The force flag resets the value to \[default value of the new type]. The property of selection types, and the old values are not compatible with property Non-compatible selection is not allowed, no conversion unless force flag is set The property \[propertyname] of type \[typename] cannot be converted to the new property because of an incompatible selection. The force flag resets the value to \[default value of the new type].
If a type defines custom properties for child entities. Child entities are converted first. Propertynames in error messages are prefixed. For example, "The deployment profile property ..."    
Dynamic Properties A dynamic property with the same name and type are defined on the entity. Nothing happens with the value.  
The dynamic property is missing on the entity. It is added with the default value.  
The dynamic property exists on the entity but has a different type. The system will try to convert the value to the new property type and fail if this is not possible. The same rules as with custom properties apply. The dynamic property \[propertyname] of type \[typename] cannot be converted to the new property type \[new type of property]. The force flag resets the value to \[default value of the new type].
Package Custom Types The base type is different. Conversation will fail. Upgrading entities to a different base type is not supported. Changing the base type of the package from \[base type] to \[base type] is not supported.
The package state does not exist in the new version. Conversation will fail. The force flag will reset the value but not trigger state change events. The package is in the state \[package state] which does not exist in the new type version. The force flag resets the state to \[default state] but will not trigger any state change events.
Reservation Custom Types The base type of the reservation is different in the new version. Conversation will fail. The base type cannot be changed from \[old basetype] to \[new basetype].
Workflow Custom Types The workflow mode is different in the new version. The conversation works.