Get query

Retrieve the details of a saved query. Its results can be retrieved using the query results endpoint.

Required permission: Reporting

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the query

Query Params
boolean

When true, only AI-generated reports are returned; when false, only classic query-builder queries. Omit to return both. Only narrows results the caller would already receive: it never adds AI reports for callers that did not opt into them.

boolean

When true, AI-generated reports that define a set of people are returned alongside the module's classic queries. Used by pickers whose consumer resolves people (workflow triggers, access criteria, check-in rooms). The flag also excludes AI reports that define no person set, including when Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.Module is omitted.

boolean

When true, AI-generated reports are returned alongside the module's classic queries, whether or not they define a person set. AI reports follow the Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.Module filter like classic queries; without this flag (or Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.PersonSets) they are excluded. Used by the Query Builder's saved-query switcher and the scheduler/widget pickers; person-set pickers use Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.PersonSets instead.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json