OMomniapp
Query

Wait for query jobs to complete

Changed on

Waits for previously submitted query jobs and streams results as they complete. The response is a stream of newline-delimited JSON (Content-Type: text/ndjson): one line per job (same shape as the job lines from query/run, including the base64-encoded Arrow IPC result), then a footer. Unlike query/run, there is no jobs_submitted header line. If the footer's remaining_job_ids is non-empty, call this endpoint again with those IDs until it is empty.

get/api/v1/query/wait

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/query/wait
  • Auth
    HTTP bearer

Query parameters

completionOnly'true' | 'false'

If "true", completed job lines omit result; read the data afterwards with GET /api/v1/query/results.

jobIdsstring

Comma-separated list of job UUIDs to wait for. Obtained from the query/run response. Required unless the deprecated job_ids is sent.

Example:123e4567-e89b-42d3-a456-426614174000,123e4567-e89b-42d3-a456-426614174001
job_idsstring

Deprecated: use jobIds instead. JSON array or comma-separated list of job UUIDs.

Response

Query results for completed jobs, as a text/ndjson stream — one JSON object per line, each matching QueryWaitStreamLine; it cannot be parsed as a single JSON document.

Changes

  • 1928c8cc5ec5Revision changes
    • info

      added the new optional query request parameter completionOnly

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • febf0a61f153Revision changes
    • info

      added the new optional query request parameter job_ids

    • info

      the query request parameter jobIds became optional