🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The enableFieldAliasSchemaOnViews() mutation activates a field alias schema on one or more views or repositories. After activation, the schema's field alias mappings apply during searches within those views or repositories. Use this mutation to target specific views; use enableFieldAliasSchemaOnOrg() to apply a schema across all views and repositories in the organization. This mutation is atomic: if activation fails for any specified view, no changes apply to any of them.

Syntax

graphql
enableFieldAliasSchemaOnViews(
      input: EnableFieldAliasSchemaOnViewsInput!
   ): Boolean!

The required input argument takes an EnableFieldAliasSchemaOnViewsInput object. Provide the schema identifier and the names of the target views or repositories. Use the fieldAliasSchemas() query to retrieve available schema IDs. See the Input Parameters section for details.

The mutation returns a non-null Boolean!. A true result confirms the schema was activated on all specified views.

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

Both fields in EnableFieldAliasSchemaOnViewsInput are required. Use fieldAliasSchemas() to retrieve the schema identifier. The viewNames field accepts both view and repository names. The following table describes the input fields:

Table: EnableFieldAliasSchemaOnViewsInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
schemaIdStringyes Long-Term The unique identifier of the schema related to the field aliases to enable.
viewNamesStringyes Long-Term The names of the views related to the field aliases to enable.