ON THIS PAGE
POST /ariel/processors/aql_metadata
SUMMARY Parses the AQL query expression and returns metadata for this query
Parses the Ariel Query Language (AQL) query expression and returns expected metadata without execution of the query
This endpoint only accepts SELECT query expressions.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
query_expression |
query |
Required |
String |
text/plain |
Required - The AQL query for metadata. |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
An AQL query expression was successfully validated. |
|
422 |
2000 |
The query_expression contains invalid AQL syntax. |
500 |
1020 |
An error occurred during the attempt to validate AQL. |
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 AQL query. 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" } ] }