SCDefnVariable

SC Defn Variables define the details about variables defined in the SC Defn.

Properties

Name	Type	Description	Notes
default_value	str	The default value of this variable.	[optional]
displayable	bool	A flag indicating if values for this variable should be displayed.	[optional]
generate	bool	A flag indicating if the initial value for this variable should be generated.	[optional]
generate_length	int	A length value used when generating values for this variable.	[optional]
id	str	The UUID of this SC Defn Variable.	[optional]
modifiable	bool	A flag indicating if values for this variable can be modified.	[optional]
name	str	The name of this SC Defn Variable.	[optional]
order	int	A value that specifies the order of this variable with respect to the other variables in the SC Defn.	[optional]
prompt	str	Optional prompt to be used when prompting for a value for this variable.	[optional]
required	bool	A flag indicating if a value is required for this variable.	[optional]
restriction_digits	str	A value specifying restrictions on digits appearing in values of this variable.	[optional]
restriction_lower	str	A value specifying restrictions on lowercase characters appearing in values of this variable.	[optional]
restriction_max	int	A value indicating a maximum for values of this variable. How this is enforced depends on the variable type.	[optional]
restriction_min	int	A value indicating a minimum for values of this variable. How this is enforced depends on the variable type.	[optional]
restriction_regex	str	A value specifying a regex that values of this variable must match.	[optional]
restriction_special	str	A value specifying restrictions on special characters appearing in values of this variable.	[optional]
restriction_upper	str	A value specifying restrictions on uppercase characters appearing in values of this variable.	[optional]
sc_defn_id	str	The UUID of the SC Defn that owns this variable definition.	[optional]
type	str	The type of this variable.	[optional]
uniqueness	str	A flag indicating if values of this variable must be unique and if so within what scope.	[optional]
uniqueness_scope_id	str	A value that allows a variable to be defined unique in the scope of another variable.	[optional]

Example