The fieldAliasSchemaOnView() GraphQL query is used to retrieve the active schema and its field aliases on a given view.

Syntax

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

graphql
fieldAliasSchemaOnView(
      repoOrViewName: string!
   ): FieldAliasSchema

For the input of this query, give the name of the repository or view you want to query within quote marks. For the return values to request, enter them within curly-brackets. A list of your choices are in the Returned Datatype section. Here's an example of how you might use this query field:

Raw
graphql
query {
  fieldAliasSchemaOnView(repoOrViewName: "humio") {
    id, name, fields {
      description
    }
  }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") {
    id, name, fields {
      description
    }
  }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") {
    id, name, fields {
      description
    }
  }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") { ^
    id, name, fields { ^
      description ^
    } ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") {
    id, name, fields {
      description
    }
  }
}"
}'
"$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") {
    id, name, fields {
      description
    }
  }
}"
}';
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") {
    id, name, fields {
      description
    }
  }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  fieldAliasSchemaOnView(repoOrViewName: \"humio\") {
    id, name, fields {
      description
    }
  }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "fieldAliasSchemaOnView": {
      "id": "kJvnpfCzPILaNDcJydaKI0fpJleRc6ca",
      "name": "Tester",
      "fields": [
        {
          "description": "Host"
        },
        {
          "description": "IP Address"
        }
      ]
    }
  }
}

Returned Datatypes

The FieldAliasSchema, datatype has a few parameters, a couple with additional parameters of their own. They're listed here:

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.