POST /ariel/validators/aql

Validates the AQL query expression.

Validates the Ariel search as specified by the Ariel Query Language (AQL) query expression.

This endpoint only accepts SELECT query expressions.

Table 1. POST /ariel/validators/aql resource details
MIME Type
application/json

Table 2. POST /ariel/validators/aql request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
query_expression	query	Required	String	text/plain	Required - The AQL query to validate.
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. POST /ariel/validators/aql response codes
HTTP Response Code	Unique Code	Description
200		An AQL query expression was successfully validated.
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

Array of errors/warnings encountered during AQL validation or null if validation was successful

Response Sample


{
    "error_messages": [
        {
            "code": 42,
            "contexts": [
                "String"
            ],
            "message": "String",
            "severity": "String <one of: INFO, WARN, ERROR>"
        }
    ]
}