Summary

The setFieldConfiguration() GraphQL mutation field is used to save UI styling and other properties for a field. They'll be used whenever the field is added to a table or event list in LogScale's UI.

API Stability Long-Term

Syntax

graphql
setFieldConfiguration(
      input: FieldConfigurationInput!
   ): boolean

For the input, you'll have to give the unique identifier for the repository or view, the name of the field, and the JSON configuration. See the Input Parameters for details.

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

Example

Raw
graphql
mutation {
  setFieldConfiguration( input: {
    viewId: "abc123",
    fieldName: "#kind",
    json: [ { #type=kv } ]
  }  )
}
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 {
  setFieldConfiguration( input: {
    viewId: \"abc123\",
    fieldName: \"#kind\",
    json: [ { #type=kv } ]
  }  )
}"
}
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 {
  setFieldConfiguration( input: {
    viewId: \"abc123\",
    fieldName: \"#kind\",
    json: [ { #type=kv } ]
  }  )
}"
}
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 { ^
  setFieldConfiguration( input: { ^
    viewId: \"abc123\", ^
    fieldName: \"#kind\", ^
    json: [ { #type=kv } ] ^
  }  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setFieldConfiguration( input: {
    viewId: \"abc123\",
    fieldName: \"#kind\",
    json: [ { #type=kv } ]
  }  )
}"
}'
    "$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 {
  setFieldConfiguration( input: {
    viewId: \"abc123\",
    fieldName: \"#kind\",
    json: [ { #type=kv } ]
  }  )
}";
$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 {
  setFieldConfiguration( input: {
    viewId: \"abc123\",
    fieldName: \"#kind\",
    json: [ { #type=kv } ]
  }  )
}"
}'''

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 {
  setFieldConfiguration( input: {
    viewId: \"abc123\",
    fieldName: \"#kind\",
    json: [ { #type=kv } ]
  }  )
}"
}
);


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

Input Parameters

For the input, you'll have to give the unique identifier for the repository or view, the name of the field, and the JSON configuration. These parameters are described in the table below:

Table: FieldConfigurationInput 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 18, 2024
fieldNamestringyes Long-TermThe name of the field for configuration.
jsonJSONyes Long-TermThe json configuration. JSON is a scalar.
viewIdstringyes Long-TermThe unique identifier for the view.