This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of reports.
The queryReports()
function builds a query to retrieve a list of reports and returns a ReportsQueryBuilder
object.
The returned object contains the query definition, which is typically used to run the query using the find()
function.
You can refine the query by chaining ReportsQueryBuilder
functions onto the query. ReportsQueryBuilder
functions enable you to sort, filter, and control the results queryReports()
returns.
queryReports()
runs with these ReportsQueryBuilder
defaults, which you can override:
limit(50)
descending("_createdDate")
The functions that are chained to queryReports()
are applied in the order they're called. For example, if you apply ascending('entityName') and then descending('createdDate'), the results are sorted first by the entity name, and then, if there are multiple results with the same name, the items are sorted by created date.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
entityName | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
entityId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
_createdDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
extendedFields | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.