API DocsRESTUser defined function service

ListUserDefinedFunctions

Retrieve the latest versions of user defined functions based on an optional filter.

GET
/api/v1/user-defined-functions

Query Parameters

pageSizeinteger

The maximum number of user defined functions to return. The service may return fewer than this value. If unspecified, at most 50 user defined functions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

Format: "int64"

pageTokenstring

A page token, received from a previous ListUserDefinedFunctions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserDefinedFunctions must match the call that provided the page token. Optional.

filterstring

A Common Expression Language (CEL) filter string. There are currently no available fields. For further information about how to use CELs, please refer to this guide.

orderBystring

How to order the retrieved user defined functions. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date, modified_date, and name. If left empty, items are ordered by name in ascending order (alphabetical). For more information about the format of this field, read this Example: "created_date desc,modified_date".

curl -X GET "<API_URL>/api/v1/user-defined-functions?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "userDefinedFunctions": [
    {
      "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"
    }
  ],
  "nextPageToken": "string"
}

Previous

ListUserDefinedFunctionVersions GET

Next

UpdateUserDefinedFunction PATCH