createFieldAliasSchema()

The createFieldAliasSchema() GraphQL mutation may be used to create a schema. If another schema already exists with the same name, this overwrites it.

Syntax

Below is the syntax for the createFieldAliasSchema() mutation field:

graphql
createFieldAliasSchema(
      input: CreateFieldAliasSchemaInput!
   ): FieldAliasSchema

Given Datatypes

For the input CreateFieldAliasSchemaInput(), there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CreateFieldAliasSchemaInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
aliasMappings[AliasMappingInput]yes The alias mapping inputs. See AliasMappingInput.
fields[SchemaFieldInput]yes The schema field inputs. See SchemaFieldInput.
namestringyes The name of the field alias schema.

Returned Datatypes

As indicated by the syntax above, this mutation will return the token using the datatype, FieldAliasSchema. Below is a list of the parameters of that datatype:

Table: FieldAliasSchema

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 25, 2024
fields[SchemaField]yes The schema fields. This uses a datatype called, SchemaField, which has two string fields: named, which is required; and description.
idstringyes The unique identifier of the field alias schema.
instances[AliasMapping]yes The instances used. See AliasMapping.
namestringyes The name of the schema.
versionstringyes The version.
yamlTemplateyamlyes A YAML template.