API Stability Preview

The disableFieldAliasSchemaOnView() GraphQL mutation is used to disable the schema on a given view or repository.

Syntax

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

graphql
disableFieldAliasSchemaOnView( 
      input: DisableFieldAliasSchemaOnViewInput!
   ): boolean

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

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

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 {
  disableFieldAliasSchemaOnView(
     input: { schemaId: \"abc123\", 
              viewName: \"humio\" }
  )
}"
}
);


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

Given Datatypes

For DisableFieldAliasSchemaOnViewInput, there are two parameters that may be given. Below is a list of them along with a description of each:

Table: DisableFieldAliasSchemaOnViewInput

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: Sep 18, 2024
schemaIdstringyes Long-TermThe unique identifier of the schema related to the field aliases to disable.
viewNamestringyes Long-TermThe name of the view related to the field aliases to disable.