Skip to main content

betaThis is a new capability. Help us improve it and give your feedback on Slack.

form-definition-v2-schema-properties-conditions-conditions-item-properties-items-items-item-oneof-generic-list-items

Condition Item Type

object (Generic List Items)

Condition Item Properties

PropertyTypeRequiredNullableDefined by
idstringOptionalcannot be nullForm Definition V2 Schema
componentIdstringRequiredcannot be nullForm Definition V2 Schema
operatorstringRequiredcannot be nullForm Definition V2 Schema
typestringRequiredcannot be nullForm Definition V2 Schema
valueMultipleRequiredcan be nullForm Definition V2 Schema

id

Unique identifier used to reference this condition

id

Id Type

string (Id)

id Constraints

UUID: the string must be a UUID, according to RFC 4122

componentId

Reference to the component id being evaluated in this condition

componentId

Component Id Type

string (Component Id)

componentId Constraints

constant: the value of this property must be equal to:

{
"ref": {
"path": [
"pages"
],
"ancestor": "root",
"in": true
}
}

operator

Comparison operator: equals, notEquals, contains, notContains, greaterThan, lessThan, isEmpty, isNotEmpty

operator

Operator Type

string (Operator)

operator Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"is"
"is not"
"is longer than"
"is shorter than"
"has length"
"contains"
"does not contain"
"is at least"
"is at most"
"is less than"
"is more than"
"is before"
"is after"

type

Type of the condition value

type

Type

string (Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"Value"
"RelativeDate"
"StringValue"
"BooleanValue"
"NumberValue"
"DateValue"
"ListItemRef"

value

Value to compare the field against, either fixed or relative date

Value can be of various types (boolean, string, number, integer, object, object).

value

Value Type

any of the following: array or boolean or number or object or string (Value)