API Stability Preview

The disableFieldAliasSchemaOnViews() GraphQL mutation field is used to disable the schema on the given views or repositories. This is a preview and subject to change. See also disableFieldAliasSchemaOnView() .

Syntax

Below is the syntax for the disableFieldAliasSchemaOnViews() mutation field:

graphql
disableFieldAliasSchemaOnViews(
       input: DisableFieldAliasSchemaOnViewsInput!
    ): boolean

There are no special returned datatypes for this mutation field. Below is an example of how it might be used:

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
  }
}

Given Datatypes

For DisableFieldAliasSchemaOnViewsInput, there are a couple of parameters. They're listed below with a description of each:

Table: DisableFieldAliasSchemaOnViewsInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Nov 13, 2024
schemaIdstringyes PreviewThe unique identifier of the schema related to the field aliases to disable.
viewNames[string]yes PreviewThe names of the views related to the field aliases to disable.