Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /ariel/searches/{search_id}

Retrieves information about an Ariel search.

Retrieve status information for a search, based on the search ID parameter. The same informational fields are returned regardless of whether the search is in progress or is complete.

Table 1: GET /ariel/searches/{search_id} Resource Details

MIME Type

application/json

Table 2: GET /ariel/searches/{search_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

search_id

path

Required

String

text/plain

Required. The identifier for an Ariel search.

Prefer

header

Optional

String

text/plain

Optional. Specify 'wait=N' where N is number of seconds to wait for COMPLETED status of the search.

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

Table 3: GET /ariel/searches/{search_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The search information was retrieved.

206

 

The search information was retrieved with 'Prefer: wait=N' timeout(sec) expired before the search is completed

404

1002

The search does not exist.

422

1005

A request parameter is not valid.

500

1020

An error occurred during the attempt to retrieve the search information.

503

1010

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

Response Description

Information about the specified search, including the search status.

Response Sample