DynamicProperty

System Property

Type

Description

Changeable

Identity

Required for creation

system_maintype

string

The main type (DynamicProperty)


system_id

int

The ID

Yes

system_on_entity

reference*

Reference to the entity (no grouped identity properties possible)

Yes

[group=g1]

Yes

system_on_maintype

string

Main type of the entity.

Yes

[group=g1]

Yes

system_overrides_entity

reference*

Reference to the entity where the property was originally defined. If there is a reference to such an entity, its dynamic property value gets overwritten by this record.


system_overrides_maintype

string

Main type of the entity where the property was originally defined.


system_caption string Optional caption of the dynamic property. Can even be set if for properties that are not prompted, but in this case they are only visible/used once the user changes it to be prompted. Yes    
system_parent_entity_maintype string

Main type of the parent of the entity the property belongs to (that is parent of system_on_entity).

It is only required if system_on_entitiy is referenced by name AND this name is not unique. If this property is specified, it has to be Application if system_on_maintype equals Component, Workflow, DeploymentProfile or Package. Otherwise, it has to be identical to system_on_maintype.

   Yes [group=g1] Yes, if name of system_on_entity is not unique
system_parent_entity Reference*

Reference to the parent of the entity the property belongs to (that is parent of system_on_entity). It is only required if system_on_entity is referenced by name AND this name is not unique.

If this property is specified, it has to reference an entity with maintype equaling system_parent_entity_maintype. Otherwise, it has to be identical to system_on_entity

   Yes [group=g1] Yes, if name of system_on_entity is not unique

system_valid_from

datetime

The start date and time when the value of this dynamic property was active


system_valid_to

datetime

The end date and time when the value of this dynamic property was active (empty if it is currently active)


system_full_name

string

The fully qualified name (including the namespace starting with /)

Yes

Yes

[group=g1]

Yes
system_type string

Can be one of the following:

  • SingleLineText
  • Float
  • Date
  • DateTime
  • Protected
  • ShortText
  • SingleChoice
  • MultiChoice
  • List
  • Reference

If not specified, SingleLineText is used as default.

      
system_mode string

Kind of the properties value. Possible values:

  • Static (default)
  • Expression

Note: To set the property to be prompted, use system_override_in and set it to Execution

      

system_value

string

The value or expression, when the value is protected, is empty.

Yes

system_choices

Multi Choice

A list of properties to chose from. For dynamic properties with system_type multichoice and singlechoice only, ignored for all other types

Yes

system_allow_custom_values

boolean

If set, you can set a value that is not in the choice list (Default = False)


system_reference_maintype string

Main type of the entity to which the reference is set. Only available if type= Reference.

Can be one of the following:

  • Application
  • Package
  • DeploymentTarget
  • Environment
  • Login
  • Member
  • Workflow
     Yes, if system_type= Reference
system_reference Reference* Reference to the entity that's referenced. Only available if type= Reference. Yes    

system_is_protected

bool

True if the value is protected

Yes

system_is_highlighted

bool

True if the value is highlighted

Yes

system_override_in

string

Where the property has to be overwritten (if any)

Yes

system_description

string

The description

Yes

* To be referenced as for example: system_folder.system_name.

Note: Properties belonging to the same group have to be defined as multi-value (which consists of different CSV values separated by #: value1#;#value2#;#value3).

Reporting

The entity is not available for reports.