createOrUpdateExternalFunction()

The createOrUpdateExternalFunction() GraphQL mutation field is used to creates or updates an external function specification. This is a preview and may change.

Syntax

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

graphql
createOrUpdateExternalFunction(
       input: CreateOrUpdateExternalFunctionInput!
    ): ExternalFunctionSpecificationOutput!

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

Raw
graphql
mutation {
  createOrUpdateExternalFunction(input:
       { name: "my-ext-function",
         procedureURL: "https://function.company.com",
         parameters: [{name: "parameter1", parameterType: String } ],
         description: "Cool External Function",
         kind: { name: General }
      } )
  { name }
}
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 {
  createOrUpdateExternalFunction(input:
       { name: \"my-ext-function\",
         procedureURL: \"https://function.company.com\",
         parameters: [{name: \"parameter1\", parameterType: String } ],
         description: \"Cool External Function\",
         kind: { name: General }
      } )
  { name }
}"
}
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 {
  createOrUpdateExternalFunction(input:
       { name: \"my-ext-function\",
         procedureURL: \"https://function.company.com\",
         parameters: [{name: \"parameter1\", parameterType: String } ],
         description: \"Cool External Function\",
         kind: { name: General }
      } )
  { name }
}"
}
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 { ^
  createOrUpdateExternalFunction(input: ^
       { name: \"my-ext-function\", ^
         procedureURL: \"https://function.company.com\", ^
         parameters: [{name: \"parameter1\", parameterType: String } ], ^
         description: \"Cool External Function\", ^
         kind: { name: General } ^
      } ) ^
  { name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createOrUpdateExternalFunction(input:
       { name: \"my-ext-function\",
         procedureURL: \"https://function.company.com\",
         parameters: [{name: \"parameter1\", parameterType: String } ],
         description: \"Cool External Function\",
         kind: { name: General }
      } )
  { name }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  createOrUpdateExternalFunction(input:
       { name: \"my-ext-function\",
         procedureURL: \"https://function.company.com\",
         parameters: [{name: \"parameter1\", parameterType: String } ],
         description: \"Cool External Function\",
         kind: { name: General }
      } )
  { name }
}"
}';
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 {
  createOrUpdateExternalFunction(input:
       { name: \"my-ext-function\",
         procedureURL: \"https://function.company.com\",
         parameters: [{name: \"parameter1\", parameterType: String } ],
         description: \"Cool External Function\",
         kind: { name: General }
      } )
  { name }
}"
}'''

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 {
  createOrUpdateExternalFunction(input:
       { name: \"my-ext-function\",
         procedureURL: \"https://function.company.com\",
         parameters: [{name: \"parameter1\", parameterType: String } ],
         description: \"Cool External Function\",
         kind: { name: General }
      } )
  { name }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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 Datatypes

For CreateOrUpdateExternalFunctionInput), there are a few parameters. Below is a list of them:

Table: CreateOrUpdateExternalFunctionInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
descriptionstringyes The description for the external function.
kindKindInputyes The kind of external function. It defines how the external function is executed. See KindInput.
namestringyes The name of the external function.
parameters[ParameterSpecificationInput]yes The parameter specifications for the external function. See ParameterSpecificationInput.
procedureURLstringyes The URL for the external function.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, ExternalFunctionSpecificationOutput. Below is the parameter of that datatype:

Table: ExternalFunctionSpecificationOutput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
descriptionstringyes The description for the external function.
kindKindOutputyes The kind of external function, how it's executed. See KindOutput.
namestringyes The name of the external function.
parameters[ParameterSpecificationOutput]yes The parameter specifications for the external function. See ParameterSpecificationOutput.
procedureURLstringyes The URL for the external function.