API Stability Long-Term

The updateFieldAliasMapping() GraphQL mutation may be used to update an alias mapping on a schema.

Related to this mutation, you can use the addFieldAliasMapping() to add a field alias map to a schema. You can use removeFieldAliasMapping() to remove 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

graphql
updateFieldAliasMapping(
      input: UpdateFieldAliasMappingInput!
   ): string

There is no special returned datatype for this mutation field.

Example

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

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

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 {
  updateFieldAliasMapping( input:
     { schemaId: \"abc123\",
       aliasMappingId: \"def456\",
       aliases: [ { source: \"some\", alias: \"thing\" } ]
     } 
  )
}"
}
);


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();

Given Datatype

For this input datatype, you'll have to give the unique identifier of the schema and alias mapping to update, the aliases, and other parameters you want to change. The table below provides details of this:

Table: UpdateFieldAliasMappingInput

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 23, 2024
aliases[AliasInfoInput]yes Long-TermA list of aliases. See AliasInfoInput.
aliasMappingIdstringyes Long-TermThe alias mapping identifier.
namestring  Long-TermThe name of the Alias mapping. This overrides the existing name. If not given, it's unchanged.
originalFieldsToKeep[string]yes Long-TermSource fields that are aliased, but should still be available in the query. This overrides the existing values. If not given, it's unchanged.
schemaIdstringyes Long-TermThe unique identifier of the schema on which the alias mapping exists.
tags[TagsInput]yes Long-TermThe tags of the alias mapping. This overrides the existing tags. If not given, they're unchanged. See TagsInput.