API Stability Long-Term

The removeFieldAliasMapping() GraphQL mutation is used to remove a field alias mapping to an existing schema.

Syntax

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

graphql
removeFieldAliasMapping(
      input: RemoveAliasMappingInput!
   ): boolean

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

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

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 {
  removeFieldAliasMapping( input: {
      schemaId: \"gtkUQlRTjo0JjGAPZ8kN45JgqKKX9ltE\",
      aliasMappingId: \"1GCjVGIuGw2L2Noc5aw2Exh4TgkW2rGy\"
  } )
}"
}
);


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

Given Datatypes

RemoveAliasMappingInput has a couple of parameters. They're listed below along with a description of each:

Table: RemoveAliasMappingInput

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.