Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

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