Retrieve query results

GET 
/api/v1/queries/:jobId

Retrieve the status and results of a CQL query

Request

Path Parameters

jobId stringrequired

jobId of the query to retrieve

Responses

200

Successfully found query

application/json

Schema

Schema

progress number

queryDetails

object

required

initiatedAt date-timerequired

jobId stringrequired

Id that can be used to request the status of the query. If you would like to re-run the query, you must re-run the query in the UI. See retrieve query results

query stringrequired

result

object[]

Array [

description string

name stringrequired

tag stringrequired

type stringrequired

]

status stringrequired

Possible values: [IN_PROGRESS, DONE, CANCELLED, FAILURE, TIMED_OUT]

Example (from schema)

{
  "progress": 0,
  "queryDetails": {
    "initiatedAt": "2024-07-29T15:51:28.071Z",
    "jobId": "string",
    "query": "string"
  },
  "result": [
    {
      "description": "string",
      "name": "string",
      "tag": "string",
      "type": "string"
    }
  ],
  "status": "IN_PROGRESS"
}

404

Query not found

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...