API Stability Long-Term

The fieldAliasSchemas() GraphQL query is used to retrieve all of the schemas for any field aliases.

Syntax

Below is the syntax for the fieldAliasSchemas() query field:

graphql
fieldAliasSchemas: FieldAliasSchemasInfo

The FieldAliasSchemasInfo() has a few parameters, but those in turn have several parameters of their own. You see that in the example below:

Show:
graphql
query {
  fieldAliasSchemas {
     schemas {id, name}
     activeSchemaOnOrg
     activeSchemasOnViews {viewName}}
}
Example Responses
Show:
json
{
  "data": {
    "fieldAliasSchemas": {
      "schemas": [
        {
          "id": "kJvnpfCzYHBaNDcJydaWI0fpMleRc6ca",
          "name": "Tester"
        }
      ],
      "activeSchemaOnOrg": "Mnokjql1c3871mNJem",
      "activeSchemasOnViews": [
        {
          "viewName": "httplogs"
        }
      ]
    }
  },
}

Returned Datatypes

The returned datatype FieldAliasSchemasInfo has only a few parameters. Below is a list of them along with a description of each:

Table: FieldAliasSchemasInfo

ParameterTypeRequiredDefaultStabilityDescription
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
activeSchemaOnOrgstring  Long-TermThe currently active schema for the organization.
activeSchemasOnViews[ActiveSchemaOnView]yes Long-TermThe currently active schemas for views. See ActiveSchemaOnView.
schemas[FieldAliasSchema]yes Long-TermList of field alias schemas. See FieldAliasSchema.