๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The disableFieldAliasSchemaOnOrg() mutation removes a field alias schema assignment from the organization associated with the authenticated token. Removing the assignment stops the schema's aliases from applying across all repositories and views in that organization. The schema itself is not deleted and remains available for reassignment. To remove a schema assignment from specific views rather than the entire organization, use disableFieldAliasSchemaOnView() or disableFieldAliasSchemaOnViews() instead.

Syntax

graphql
disableFieldAliasSchemaOnOrg(
      input: DisableFieldAliasSchemaOnOrgInput!
   ): Boolean!

The mutation accepts a required input argument of type DisableFieldAliasSchemaOnOrgInput. Provide the unique identifier of the field alias schema to remove from the organization. Use fieldAliasSchemas() to retrieve the schema identifier.

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

Example

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

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 {
  disableFieldAliasSchemaOnOrg( input:  
    { schemaId: \"abc123\" } )
}"
}
);


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

Input Parameters

The DisableFieldAliasSchemaOnOrgInput type requires a single field: the unique identifier of the field alias schema to remove from the organization, as described in the following table:

Table: DisableFieldAliasSchemaOnOrgInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
schemaIdStringyesย Long-Termย The unique identifier of the field alias schema to remove from the organization. Use the fieldAliasSchemas() query to list available schemas and retrieve identifiers.