← All native models

Native model

workspace_variant

Declare a named workspace_variant value and reference it as workspace_variant.your_name. Models have no separate platform identity or lifecycle.

Topics: Surfaces

Fields

Lets the user choose one of several shapes for part of the input, for example a person or a company, each with its own fields.

object
childrenRequired
array
Minimum items
1
Maximum items
9223372036854776000
List items
Choose exactly one shape
All of these apply
componentRequired
string
Value
"variant"
defaultCaseOptional

Case selected initially for new records. Never overrides the case of an existing record.

string
discriminatorOptional

The input member that records the chosen case. Required for discriminator encoding.

string
encodingRequired

How the choice is sent: one-of for a GraphQL OneOf input, discriminator for an input with a type field.

string
Allowed values
["one-of","discriminator"]
Minimum length
1
idRequired

Unique identifier: lowercase letters, digits and hyphens, starting with a letter.

string
Minimum length
1
labelRequired

Label shown above the choice of cases.

string
Minimum length
1
pathRequired

Path of the input object the variant fills.

string
Minimum length
1
sourceOptional

Path in the edited record that supplies the initial value.

string
stateOptional

Workspace state key whose value fills this input. Editing the form does not change that state.

string
submitOptional

always sends the value every time; changed sends it only when the user changed it.

string
Allowed values
["always","changed"]

Only the fields listed here are accepted.