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

ParameterTypeRequired[a]DefaultDescription
schemaIdstringyes The unique identifier of the schema on which the alias mapping exists.
aliasMappingIdstringyes The alias mapping identifier.
namestring  The name of the Alias mapping. This overrides the existing name. If not supplied, the name will be unchanged.
tags[TagsInput]yes The tags of the alias mapping. This will override the existing tags. If not given, the tags will be unchanged.
aliases[AliasInfoInput]yes A list of aliases (see AliasInfoInput table).
originalFieldsToKeep[string]yes Source fields that are aliased, but should still be available in query. Overrides the existing values for this field. If not supplied, this field will be unchanged.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


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

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the field alias schema.
namestringyes The name of the schema.
fields[SchemaField]yes The schema fields. This uses a datatype called, SchemaField, which has two string fields: named, which is required; and description.
instances[AliasMapping]yes The instances used. See the AliasMapping table.
versionstringyes The version.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.