API DocsRESTUser defined function service

CreateUserDefinedFunction

Create a user defined function.

POST
/api/v1/user-defined-functions

Request Body

application/jsonRequired

name
Required
string

descriptionstring

expression
Required
string

functionInputs
Required
array<object>

userNotesstring

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

A successful response.

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

Previous

ListUnits GET

Next

GetUserDefinedFunction GET