Summary

The getExternalFunction() GraphQL query to look up an external function specification. This query field is a preview and subject to change.

API Stability Preview

Syntax

graphql
getExternalFunction(
      input: GetExternalFunctionInput!
   ): ExternalFunctionSpecificationOutput

For the input, you'd enter the name of the external function and the related view. This is described in the Input Parameters section. For the results, you can get the details of the external function (e.g., the function's URL and parameters). See the Returned Datatype section further down this page.

Example

Raw
graphql
query {
  getExternalFunction(
    input: {name: "company-http", 
            view: "xxxx"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}
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" : "query {
  getExternalFunction(
    input: {name: \"company-http\", 
            view: \"xxxx\"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}"
}
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" : "query {
  getExternalFunction(
    input: {name: \"company-http\", 
            view: \"xxxx\"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}"
}
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" : "query { ^
  getExternalFunction( ^
    input: {name: \"company-http\",  ^
            view: \"xxxx\"} ^
  ) { ^
    kind, name,  ^
    description, ^
    procedureURL, ^
    parameters { ^
      name, parameterType, defaultValue ^
    }     ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  getExternalFunction(
    input: {name: \"company-http\", 
            view: \"xxxx\"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}"
}'
    "$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 = "query {
  getExternalFunction(
    input: {name: \"company-http\", 
            view: \"xxxx\"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}";
$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" : "query {
  getExternalFunction(
    input: {name: \"company-http\", 
            view: \"xxxx\"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}"
}'''

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" : "query {
  getExternalFunction(
    input: {name: \"company-http\", 
            view: \"xxxx\"}
  ) {
    kind, name, 
    description,
    procedureURL,
    parameters {
      name, parameterType, defaultValue
    }    
  }
}"
}
);


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

Input Parameters

For the input, you'd enter the name of the external function and the related view. This is described in the table here:

Table: GetExternalFunctionInput 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
namestringyes PreviewThe name of the external function to fetch.
viewstringyes PreviewThe view on which the external function should be accessible.

Returned Values

For the results, you can get the external function's URL and its parameters, as well as its output, what to expect in return when you execute the function. Click on the special datatype for that particular option in the table below to see more:

Table: ExternalFunctionSpecificationOutput 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 24, 2024
descriptionstringyes PreviewThe description for the external function.
kindKindOutputyes PreviewThe kind of external function, how it's executed. See KindOutput.
namestringyes PreviewThe name of the external function.
parameters[ParameterSpecificationOutput]yes PreviewThe parameter specifications for the external function. See ParameterSpecificationOutput.
procedureURLstringyes PreviewThe URL for the external function.