Skip to main content

Fields

code : String! required

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

displayValue : String! required

The stored value for the field, formatted for display.

label : String! required

The human-readable label for the field.

rawValue : String

The stored value for the field, serialised so it can be put back into an input control and sent back unchanged. Unlike displayValue, choice fields give their value rather than their label, and booleans give true / false. Join on code against supplyPointFieldDefinitions to learn the field's type.

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

{ "code": "usually-into-try-dinner-side", "displayValue": "itself-consider-spend-star-anyone", "label": "teacher-foreign-central-plan-act", "rawValue": "machine-man-executive-now-try" }