GET /ariel/functions/{function_name}

Retrieves AQL Function with given name for a given database.

Retrieves AQL Function

Table 1. GET /ariel/functions/{function_name} resource details
MIME Type

application/json

Table 2. GET /ariel/functions/{function_name} request parameter details
Parameter Type Optionality Data Type MIME Type Description

database

query

Required

String

text/plain

Required - Name of DB to retrieve functions for.

function_name

path

Required

String

text/plain

Required - The name of function to retrieve.

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.

Table 3. GET /ariel/functions/{function_name} response codes
HTTP Response Code Unique Code Description

200

Function is retrieved

Response Description

List of AQL Functions.

Response Sample


{
    "args_types": [
        "String"
    ],
    "catalog": "String",
    "class_name": "String",
    "info": "String",
    "name": "String",
    "required_args": 42,
    "required_capabilities": "String",
    "return_type": "String",
    "var_args": true
}