SchemaField is a datatype for a schema field.

This datatype is used by the datatype, FieldAliasSchema, which is used primarily and directly by several mutation fields: createFieldAliasSchema(); createFieldAliasSchemaFromTemplate(); and updateFieldAliasSchema(). Use deleteFieldAliasSchema() to remove a field alias. There's also the fieldAliasSchemaOnView() query field for retrieving field schema.

Table: SchemaField

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 3, 2024
descriptionstring  Long-TermAn optional description of the schema field.
namestringyes Long-TermThe name of the schema field.