🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The disableFieldAliasSchemaOnViews() mutation disables an active field alias schema on one or more views or repositories in a single operation. To disable a schema on a single view, use disableFieldAliasSchemaOnView() instead.

Syntax

graphql
disableFieldAliasSchemaOnViews(
      input: DisableFieldAliasSchemaOnViewsInput!
   ): Boolean!

The mutation accepts a required input argument of type DisableFieldAliasSchemaOnViewsInput. Provide the unique identifier of the schema to disable and the list of view or repository names. Use fieldAliasSchemas() to retrieve the schema ID.

The mutation returns a non-null Boolean confirming whether the operation succeeded.

Example

Raw
graphql
mutation {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: "1234", 
             viewNames: ["humio", "testeroo"]}
  )
}
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 {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: \"1234\", 
             viewNames: [\"humio\", \"testeroo\"]}
  )
}"
}
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 {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: \"1234\", 
             viewNames: [\"humio\", \"testeroo\"]}
  )
}"
}
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 { ^
  disableFieldAliasSchemaOnViews( ^
     input: {schemaId: \"1234\",  ^
             viewNames: [\"humio\", \"testeroo\"]} ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: \"1234\", 
             viewNames: [\"humio\", \"testeroo\"]}
  )
}"
}'
    "$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 {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: \"1234\", 
             viewNames: [\"humio\", \"testeroo\"]}
  )
}";
$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 {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: \"1234\", 
             viewNames: [\"humio\", \"testeroo\"]}
  )
}"
}'''

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 {
  disableFieldAliasSchemaOnViews(
     input: {schemaId: \"1234\", 
             viewNames: [\"humio\", \"testeroo\"]}
  )
}"
}
);


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": {
    "disableFieldAliasSchemaOnViews": true
  }
}

Input Parameters

Provide the unique identifier of the field alias schema to disable and the names of the target views or repositories. Both fields are required. The following table describes each input field:

Table: DisableFieldAliasSchemaOnViewsInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
schemaIdStringyes Preview The unique identifier of the schema related to the field aliases to disable.
viewNamesStringyes Preview The names of the views related to the field aliases to disable.