Skip to main content

Fields

choices : [SupplyPointFieldChoiceType!]! required

The selectable options for a choice field. Empty for other field types.

code : String! required

The field code. May be a dotted path into the stored payload, e.g. 'contracted_powers.period_1'.

defaultValue : String

The value to pre-fill when the field has no stored value.

name : String! required

The human-readable label for the field.

required : Boolean! required

Whether the field must always be provided.

requiredRules : [SupplyPointFieldRuleType!]! required

Rules describing when the field becomes required, on top of required. Empty means the field is never conditionally required.

source : SupplyPointFieldSourceEnum! required

Whether the field is populated by industry validation (AUTO) or entered by the agent (AGENT).

visibilityRules : [SupplyPointFieldRuleType!]! required

Rules describing when the field is shown, on top of any section rules. Empty means always shown.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "choices": [SupplyPointFieldChoiceType], "code": "six-establish-indicate-work-later", "defaultValue": "partner-until-community-allow-building", "fieldType": "STR", "name": "no-rich-south-grow-this", "required": true, "requiredRules": [SupplyPointFieldRuleType], "section": SupplyPointFieldSectionType, "source": "AUTO", "visibilityRules": [SupplyPointFieldRuleType] }