GET /dynamic_search/schemas/{name}/functions

Gets the list of all available Functions

Table 1. GET /dynamic_search/schemas/{name}/functions resource details
MIME Type
application/json

Table 2. GET /dynamic_search/schemas/{name}/functions request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
name	path	Required	String	text/plain	null
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3. GET /dynamic_search/schemas/{name}/functions response codes
HTTP Response Code	Unique Code	Description
200		A list of Functions was retrieved.
404	1011	No schema with that name was found
500	1010	null

Response Description

The list of all available Functions.

name - String - The canonical name for this function.
localized_name - String - The localized name for this function.
aggregate - Boolean - A flag which indicates whether this function is an aggregating function (like COUNT) or a non-aggregating function (like STRLEN).
return_data_type - String - A string representation of the return data type of this function. (eg. STRING, INTEGER).
argument_types - List of Objects - An ordered list of the input types for this function. At present these are all data types.

Response Sample


[
    {
        "aggregate": true,
        "argument_types": [
            {
                "position": 42,
                "type": "String"
            }
        ],
        "localized_name": "String",
        "name": "String",
        "return_data_type": "String"
    }
]