GET /ariel/searches/{search_id}/metadata

Retrieve the columns that are defined for a specific Ariel search id.

Retrieve the columns that are defined for the specified Ariel search id. This is the set of columns that can be explicitly named in the column list of a SELECT query.

Table 1. GET /ariel/searches/{search_id}/metadata resource details
MIME Type
application/json

Table 2. GET /ariel/searches/{search_id}/metadata request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
search_id	path	Required	String	text/plain	null
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.
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.

Table 3. GET /ariel/searches/{search_id}/metadata response codes
HTTP Response Code	Unique Code	Description
200		Columns were successfully retrieved.
404	1002	The search does not exist.
503	1010	The Ariel server might be temporarily unavailable or offline. Please try again later.

Response Description

A list of columns that are defined for the specified database. Multiple properties of each column are returned. For example, the column name or an indication that the column is indexable.

Response Sample


{
    "columns": [
        {
            "argument_type": "String",
            "indexable": true,
            "name": "String",
            "nullable": true,
            "object_value_type": "String <one of: NULL, STRUCT, Byte, Short, Integer, Long, UnsignedByte, UnsignedShort, UnsignedInt, UnsignedLong, BigInteger, Double, Float, Port, Host, HostV4V6, HostV6, MACAddress, String, ByteArray, UnsignedIntHex, Boolean, Binary>",
            "provider_name": "String"
        }
    ]
}