Run Function

Runs a specific version of a Code Engine function.

POST /api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}

Run Function

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName} \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "inputVariables": {
    "paramName": "value"
  },
  "settings": {
    "getLogs": true
  }
}
'

import requests

url = "https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}"

payload = {
    "inputVariables": { "paramName": "value" },
    "settings": { "getLogs": True }
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inputVariables: {paramName: 'value'}, settings: {getLogs: true}})
};

fetch('https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'inputVariables' => [
        'paramName' => 'value'
    ],
    'settings' => [
        'getLogs' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}"

	payload := strings.NewReader("{\n  \"inputVariables\": {\n    \"paramName\": \"value\"\n  },\n  \"settings\": {\n    \"getLogs\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputVariables\": {\n    \"paramName\": \"value\"\n  },\n  \"settings\": {\n    \"getLogs\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/codeengine/v2/packages/{packageId}/versions/{version}/functions/{functionName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inputVariables\": {\n    \"paramName\": \"value\"\n  },\n  \"settings\": {\n    \"getLogs\": true\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "executionId": "<string>",
  "packageId": "<string>",
  "version": "<string>",
  "functionName": "<string>",
  "status": "<string>",
  "settings": {
    "getLogs": true
  },
  "startedOn": "2023-11-07T05:31:56Z",
  "startedBy": "<string>",
  "completedOn": "2023-11-07T05:31:56Z",
  "result": "<unknown>",
  "stdout": {
    "log": [
      "<unknown>"
    ]
  },
  "stderr": {
    "log": [
      "<unknown>"
    ]
  },
  "errorInformation": {
    "result": "<unknown>",
    "expectedType": "<string>",
    "actualType": "<string>",
    "expectedIsList": true,
    "actualIsList": true,
    "expectedAllowNull": true,
    "errorMessages": [
      "<string>"
    ]
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

packageId · string<uuid> · required

version · string · required

Example:

"1.0.1"

functionName · string · required

Example:

"getExecutionDetails"

Body

application/json

inputVariables · object

Key-value pairs matching the function's input parameters.

Example:

{ "paramName": "some value" }

settings · object

Show child attributes

Response

200

application/json

OK. Returns the execution details and result.

executionId · string

packageId · string

version · string

functionName · string

status · string

settings · object

Show child attributes

startedOn · string<date-time>

startedBy · string

completedOn · string<date-time>

result · any

The output of the function (type 'any').

stdout · object

Show child attributes

stderr · object

Show child attributes

errorInformation · object

Show child attributes