QueryResponse interface

Query result.

Properties

count

Number of records returned in the current response. In the case of paging, this is the number of records in the current page.

data

Query output in JObject array or Table format.

facets

Query facets.

resultTruncated

Indicates whether the query results are truncated.

skipToken

When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.

totalRecords

Number of total records matching the query.

Property Details

count

Number of records returned in the current response. In the case of paging, this is the number of records in the current page.

count: number

Property Value

number

data

Query output in JObject array or Table format.

data: Record<string, unknown>

Property Value

Record<string, unknown>

facets

Query facets.

facets?: FacetUnion[]

Property Value

resultTruncated

Indicates whether the query results are truncated.

resultTruncated: ResultTruncated

Property Value

skipToken

When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.

skipToken?: string

Property Value

string

totalRecords

Number of total records matching the query.

totalRecords: number

Property Value

number