SCDefnVariable

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

Properties

Name	Type	Description	Notes
defaultValue	String	The default value of this variable.	[optional]
displayable	Boolean	A flag indicating if values for this variable should be displayed.	[optional]
generate	Boolean	A flag indicating if the initial value for this variable should be generated.	[optional]
generateLength	Integer	A length value used when generating values for this variable.	[optional]
id	String	The UUID of this SC Defn Variable.	[optional]
modifiable	Boolean	A flag indicating if values for this variable can be modified.	[optional]
name	String	The name of this SC Defn Variable.	[optional]
order	Integer	A value that specifies the order of this variable with respect to the other variables in the SC Defn.	[optional]
prompt	String	Optional prompt to be used when prompting for a value for this variable.	[optional]
required	Boolean	A flag indicating if a value is required for this variable.	[optional]
restrictionDigits	RestrictionDigitsEnum	A value specifying restrictions on digits appearing in values of this variable.	[optional]
restrictionLower	RestrictionLowerEnum	A value specifying restrictions on lowercase characters appearing in values of this variable.	[optional]
restrictionMax	Integer	A value indicating a maximum for values of this variable. How this is enforced depends on the variable type.	[optional]
restrictionMin	Integer	A value indicating a minimum for values of this variable. How this is enforced depends on the variable type.	[optional]
restrictionRegex	String	A value specifying a regex that values of this variable must match.	[optional]
restrictionSpecial	RestrictionSpecialEnum	A value specifying restrictions on special characters appearing in values of this variable.	[optional]
restrictionUpper	RestrictionUpperEnum	A value specifying restrictions on uppercase characters appearing in values of this variable.	[optional]
scDefnId	String	The UUID of the SC Defn that owns this variable definition.	[optional]
type	TypeEnum	The type of this variable.	[optional]
uniqueness	UniquenessEnum	A flag indicating if values of this variable must be unique and if so within what scope.	[optional]
uniquenessScopeId	String	A value that allows a variable to be defined unique in the scope of another variable.	[optional]

RestrictionDigitsEnum

Name	Value
ALLOWED	"ALLOWED"
REQUIRED	"REQUIRED"
NOT_ALLOWED	"NOT_ALLOWED"
NOT_SET	"NOT_SET"

RestrictionLowerEnum

Name	Value
ALLOWED	"ALLOWED"
REQUIRED	"REQUIRED"
NOT_ALLOWED	"NOT_ALLOWED"
NOT_SET	"NOT_SET"

RestrictionSpecialEnum

Name	Value
ALLOWED	"ALLOWED"
REQUIRED	"REQUIRED"
NOT_ALLOWED	"NOT_ALLOWED"
NOT_SET	"NOT_SET"

RestrictionUpperEnum

Name	Value
ALLOWED	"ALLOWED"
REQUIRED	"REQUIRED"
NOT_ALLOWED	"NOT_ALLOWED"
NOT_SET	"NOT_SET"

TypeEnum

Name	Value
STRING	"STRING"
BOOLEAN	"BOOLEAN"
INTEGER	"INTEGER"
UUID	"UUID"

UniquenessEnum

Name	Value
GLOBAL	"GLOBAL"
USER	"USER"
NONE	"NONE"