OMomni
Queries

Wait for query results

Changed on

Poll for the results of one or more query jobs. Use this endpoint when a request to the Run query endpoint times out and returns remaining_job_ids in the response.

This endpoint waits for the specified jobs to complete and returns their results as a stream of newline-delimited JSON: one line per completed job, followed by a footer line.

If the footer's remaining_job_ids is not empty, call this endpoint again with those IDs until the list is empty and timed_out is "false".

get/v1/query/wait

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/query/wait
  • Auth
    HTTP bearer

Query parameters

completionOnly'true' | 'false'

If "true", completed job lines omit result; read the data afterward with the Read query results by offset endpoint. See Reading large results for more information.

jobIdsstring
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890,b2c3d4e5-f6a7-8901-bcde-f12345678901

Required unless the deprecated job_ids parameter is sent. A comma-separated list of job UUIDs to poll for results. These IDs are returned in the remaining_job_ids property when a request to the Run query endpoint times out.

For example, ?jobIds=a1b2c3d4-e5f6-7890-abcd-ef1234567890,b2c3d4e5-f6a7-8901-bcde-f12345678901. A value that is not a valid UUID returns a 400 error.

job_idsstring

Deprecated: Use jobIds instead.

Response

Query results for completed jobs, streamed as newline-delimited JSON (text/ndjson): one object per line. The response as a whole cannot be parsed as a single JSON document — parse it line by line.

The stream ends with a footer line. If the footer's remaining_job_ids is not empty, continue polling this endpoint with those IDs until the list is empty.

Changes

  • 43290040f88fRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      added the new optional query request parameter completionOnly

    • info

      added the new optional query request parameter jobIds

    • info

      the query request parameter job_ids became optional

    • info

      query request parameter job_ids was deprecated

    • info

      for the query request parameter job_ids, the type was generalized from array to string

    • info

      added the media type text/ndjson for the response with the status

    • info

      added the non-success response with the status