The fieldAliasSchemaOnView()
Below is the syntax for the
fieldAliasSchemaOnView()
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:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw query {
fieldAliasSchemaOnView( repoOrViewName : "humio" ) {
id, name, fields {
description
}
}
} Mac OS or Linux (curl) 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
}
}
}"
}
EOFMac OS or Linux (curl) One-line 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
}
}
}"
}
EOFWindows Cmd and curl 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 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
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
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 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 Show:
Success (HTTP Response Code 200 OK)
Success (HTTP Response Code 200 OK) {
"data" : {
"fieldAliasSchemaOnView" : {
"id" : "kJvnpfCzPILaNDcJydaKI0fpJleRc6ca" ,
"name" : "Tester" ,
"fields" : [
{
"description" : "Host"
} ,
{
"description" : "IP Address"
}
]
}
}
}
The FieldAliasSchema , datatype has a few
parameters, a couple with additional parameters of their own.
They're listed here:
Table: FieldAliasSchema
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required Table last updated: Mar 26, 2025 fields[SchemaField yes Long-TermThe schema fields. See SchemaField idstring yes Long-TermThe unique identifier of the field alias schema. instances[AliasMapping yes Long-TermThe instances used. See AliasMapping namestring yes Long-TermThe name of the schema. versionstring yes Long-TermThe version. yamlTemplateYAMLyes Long-TermA YAML template.
