Skip to main content

SCDefnVariable

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

Properties

NameTypeDescriptionNotes
DefaultValuestringThe default value of this variable.[optional]
Displayablebool?A flag indicating if values for this variable should be displayed.[optional]
Generatebool?A flag indicating if the initial value for this variable should be generated.[optional]
GenerateLengthint?A length value used when generating values for this variable.[optional]
IdstringThe UUID of this SC Defn Variable.[optional]
Modifiablebool?A flag indicating if values for this variable can be modified.[optional]
NamestringThe name of this SC Defn Variable.[optional]
Orderint?A value that specifies the order of this variable with respect to the other variables in the SC Defn.[optional]
PromptstringOptional prompt to be used when prompting for a value for this variable.[optional]
Requiredbool?A flag indicating if a value is required for this variable.[optional]
RestrictionDigitsstringA value specifying restrictions on digits appearing in values of this variable.[optional]
RestrictionLowerstringA value specifying restrictions on lowercase characters appearing in values of this variable.[optional]
RestrictionMaxint?A value indicating a maximum for values of this variable. How this is enforced depends on the variable type.[optional]
RestrictionMinint?A value indicating a minimum for values of this variable. How this is enforced depends on the variable type.[optional]
RestrictionRegexstringA value specifying a regex that values of this variable must match.[optional]
RestrictionSpecialstringA value specifying restrictions on special characters appearing in values of this variable.[optional]
RestrictionUpperstringA value specifying restrictions on uppercase characters appearing in values of this variable.[optional]
ScDefnIdstringThe UUID of the SC Defn that owns this variable definition.[optional]
TypestringThe type of this variable.[optional]
UniquenessstringA flag indicating if values of this variable must be unique and if so within what scope.[optional]
UniquenessScopeIdstringA value that allows a variable to be defined unique in the scope of another variable.[optional]