GET /ariel/searches

Retrieves the list of Ariel searches. Search IDs for completed and active searches are returned.

Retrieves the list of Ariel searches. This includes search_ids for completed and active searches.

Table 1. GET /ariel/searches resource details
MIME Type

application/json

Table 2. GET /ariel/searches request parameter details
Parameter Type Optionality Data Type MIME Type Description

db_name

query

Optional

String

text/plain

Optional - The name of the Ariel database to retrieve the list of Ariel searches.

data_lake

query

Optional

String

text/plain

Optional - If the search was for QCDL then "qcdl" should be entered in this field. Only "qcdl" can be entered in this field

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.

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.

Table 3. GET /ariel/searches response codes
HTTP Response Code Unique Code Description

200

The search list was retrieved.

500

1020

An error occurred during the attempt to retrieve the list of searches.

503

1010

The ariel server might be temporarily unavailable or offline. Please try again later.

Response Description

A list of search IDs.

Response Sample


[
    "String"
]