Skip to content

AsyncQueryResponse.md

Latest commit

 

History

History
41 lines (28 loc) · 1.03 KB

AsyncQueryResponse.md

File metadata and controls

41 lines (28 loc) · 1.03 KB

AsyncQueryResponse

Response returned when a query is submitted asynchronously (202 Accepted). Poll GET /query-runs/{id} to track progress. Once status is "succeeded", retrieve results via GET /results/{result_id}.

Properties

Name Type
queryRunId string
reason string
status string
statusUrl string

Example

import type { AsyncQueryResponse } from '@hotdata/sdk'

// TODO: Update the object below with actual values
const example = {
  "queryRunId": null,
  "reason": null,
  "status": null,
  "statusUrl": null,
} satisfies AsyncQueryResponse

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as AsyncQueryResponse
console.log(exampleParsed)

[Back to top] [Back to API list] [Back to Model list] [Back to README]