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
  }
}
'

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>"
    ]
  }
}

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