API Stability Long-Term

When enableFieldAliasSchemaOnOrg() GraphQL mutation is used, field alias mappings in a schema will be active during search across all views and repositories within the organization.

Related to this mutation, you can use the disableFieldAliasSchemaOnOrg() mutation to disable a field alias schema for an organization. Similar to both of these mutations, there is the enableFieldAliasSchemaOnViews() mutation to enable for views, and the disableFieldAliasSchemaOnView() and disableFieldAliasSchemaOnViews() to disable field alias schema based on views.

Related to all of these mutations, you can use the createFieldAliasSchema() or the createFieldAliasSchemaFromTemplate() mutation to create a field alias schema. You can use updateFieldAliasSchema() to update a schema. You can use deleteFieldAliasSchema() to delete one.

Use the fieldAliasSchemaOnView() query to get the active schema and its field aliases of a view. Use fieldAliasSchemas() to retrieve all schemas for any field aliases.

Syntax

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

graphql
enableFieldAliasSchemaOnOrg(
      input: EnableFieldAliasSchemaOnOrgInput!
   ): boolean

There are no special return datatypes for this mutation field. True is returned if successful.

Example

Below is an example of how this mutation field might be used:

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

Given Datatype

For this input datatype, you would give the unique identifier of the field alias schema to enable for the organization. This is described in the table here:

Table: EnableFieldAliasSchemaOnOrgInput

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 for the schema.