Summary

The enableFieldAliasSchemaOnViews() GraphQL mutation field is used to enable the schema on the given list of views or repositories. Field alias mappings in this schema will be active during search within this view or repository. If at least one view fails to be enabled on the given view, no changes are performed on any of the views.

API Stability Long-Term

Syntax

graphql
enableFieldAliasSchemaOnViews(
      input: EnableFieldAliasSchemaOnViewsInput!
   ): boolean

For the input, you have to give the unique identifier of the field alias schema to enable, and the name of the view or repository. Use fieldAliasSchemas() to the identifier. See the Input Parameters section for details on the input parameters.

For the results, you'll receive confirmation if successful.

Example

Raw
graphql
mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: ["humio","humio-usage"]
      schemaId: "123abc456def"
    } )
}
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" : "mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: [\"humio\",\"humio-usage\"]
      schemaId: \"123abc456def\"
    } )
}"
}
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" : "mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: [\"humio\",\"humio-usage\"]
      schemaId: \"123abc456def\"
    } )
}"
}
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" : "mutation { ^
  enableFieldAliasSchemaOnViews( input: ^
    { ^
      viewNames: [\"humio\",\"humio-usage\"] ^
      schemaId: \"123abc456def\" ^
    } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: [\"humio\",\"humio-usage\"]
      schemaId: \"123abc456def\"
    } )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: [\"humio\",\"humio-usage\"]
      schemaId: \"123abc456def\"
    } )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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" : "mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: [\"humio\",\"humio-usage\"]
      schemaId: \"123abc456def\"
    } )
}"
}'''

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" : "mutation {
  enableFieldAliasSchemaOnViews( input:
    {
      viewNames: [\"humio\",\"humio-usage\"]
      schemaId: \"123abc456def\"
    } )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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": {
    "enableFieldAliasSchemaOnViews": true
  }
}

Input Parameters

For the input, you would give the unique identifier of the field alias schema to enable, and the names of the associated views. This is described in the table here:

Table: EnableFieldAliasSchemaOnViewsInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 18, 2024
schemaIdstringyes Long-TermThe unique identifier of the schema related to the field aliases to enable.
viewNames[string]yes Long-TermThe names of the views related to the field aliases to enable.