The updateFieldAliasMapping() GraphQL mutation may be used to update an alias mapping on a schema.

Syntax

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

graphql
updateFieldAliasMapping(
      input: UpdateFieldAliasMappingInput!
   ): FieldAliasSchema

Given Datatypes

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

Table: UpdateFieldAliasMappingInput

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 23, 2024
aliases[AliasInfoInput]yes A list of aliases. See AliasInfoInput.
aliasMappingIdstringyes The alias mapping identifier.
namestring  The name of the Alias mapping. This overrides the existing name. If not given, it's unchanged.
originalFieldsToKeep[string]yes Source fields that are aliased, but should still be available in the query. This overrides the existing values. If not given, it's unchanged.
schemaIdstringyes The unique identifier of the schema on which the alias mapping exists.
tags[TagsInput]yes The tags of the alias mapping. This overrides the existing tags. If not given, they're unchanged. See TagsInput.

Returned Datatypes

The returned datatype FieldAliasSchema has its own parameters. Below is a list of them along with their datatypes and a description of each:

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.
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.