API DocsRESTUser defined function service

ValidateUserDefinedFunction

Validates a potential user defined function.

POST
/api/v1/user-defined-functions:validate

Request Body

application/jsonRequired

expression
Required
string

functionInputs
Required
array<object>

curl -X POST "<API_URL>/api/v1/user-defined-functions:validate" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "expression": "string",
    "functionInputs": [
      {
        "identifier": "string",
        "dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED"
      }
    ]
  }'

A successful response.

{
  "error": {
    "errorMessage": "string"
  },
  "success": {
    "userDefinedFunction": {
      "userDefinedFunctionId": "string",
      "name": "string",
      "archivedDate": "2019-08-24T14:15:22Z",
      "userDefinedFunctionVersionId": "string",
      "version": 0,
      "description": "string",
      "changeMessage": "string",
      "userNotes": "string",
      "expression": "string",
      "functionInputs": [
        {
          "identifier": "string",
          "dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED"
        }
      ],
      "functionOutputType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
      "functionDependencies": [
        {
          "userDefinedFunctionVersionId": "string"
        }
      ],
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string"
    }
  }
}