The addFieldAliasMapping() GraphQL mutation can be used to add a field alias mapping to an existing schema. It returns the unique identifier of the alias mapping — if successful.

For more information on dashboards, see the Dashboards & Widgets documentation page.


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

       iinput: AddAliasMappingInput!
    ): string!

Given Datatypes

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

Table: AddAliasMappingInput

schemaIdstringyes The unique identifier of the schema on which the alias mapping exists.
aliasMappingAliasMappingInputyes The alias mapping to be added to the schema. See AliasMappingInput Table.

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