FieldAliasSchema is a datatype for a field alias schema.

This datatype is used by the createFieldAliasSchema() and updateFieldAliasSchema() mutation fields. It's also used by the FieldAliasSchemasInfo datatype, which is used by the fieldAliasSchemas() query field.

Table: FieldAliasSchema

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: Mar 26, 2025
fields[SchemaField]yes Long-TermThe schema fields. See SchemaField.
idstringyes Long-TermThe unique identifier of the field alias schema.
instances[AliasMapping]yes Long-TermThe instances used. See AliasMapping.
namestringyes Long-TermThe name of the schema.
versionstringyes Long-TermThe version.
yamlTemplateYAMLyes Long-TermA yaml template. YAML is a scalar.