Summary

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

API Stability Long-Term

Syntax

graphql
removeFieldAliasMapping(
      input: RemoveAliasMappingInput!
   ): boolean

For the input, you'd give the unique identifier of the schema and the alias to remove. You can use the fieldAliasSchemas() query to find this. See the Input Parameters section.

For the results, you'll receive confirmation if successful.

Example

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

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: \"abc123\",
      aliasMappingId: \"def456\"
  } )
}"
}
);


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

Input Parameters

For the input, you'll have to give the unique identifier of the schema and that of the alias to remove. You can use the fieldAliasSchemas() query to get a list of identifiers and aliases.

Table: RemoveAliasMappingInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 19, 2024
aliasMappingIdstringyes Long-TermThe alias mapping identifier.
schemaIdstringyes Long-TermThe unique identifier of the schema on which the alias mapping exists.