List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
HTML content of the app README.
List of categories for the app.
No Additional ItemsShort description of the app.
Health status of the app.
Error if app is not healthy.
Homepage URL of the app.
Local path to the app's location.
Latest available app version.
Latest available app version in repository.
Human-readable version of the app.
Timestamp of the last update in ISO format.
Name of the app.
Indicates if the app is recommended.
Title of the app.
List of app maintainers.
No Additional ItemsName of the app maintainer.
Email address of the app maintainer.
Website URL of the app maintainer or null.
Tags associated with the app.
No Additional ItemsList of screenshot URLs.
No Additional ItemsList of source URLs.
No Additional ItemsURL of the app icon.
Name of the catalog this application comes from.
Must be at least 1 characters long
Whether this application is currently installed on the system.
The catalog train this application version belongs to.
Must be at least 1 characters long
"stable"
"enterprise"
Popularity ranking of this application. Lower numbers indicate higher popularity. null if not ranked.
Additional Properties of any type are allowed.
Type: objectHTML content of the app README.
List of categories for the app.
No Additional ItemsShort description of the app.
Health status of the app.
Error if app is not healthy.
Homepage URL of the app.
Local path to the app's location.
Latest available app version.
Latest available app version in repository.
Human-readable version of the app.
Timestamp of the last update in ISO format.
Name of the app.
Indicates if the app is recommended.
Title of the app.
List of app maintainers.
No Additional ItemsTags associated with the app.
No Additional ItemsList of screenshot URLs.
No Additional ItemsList of source URLs.
No Additional ItemsURL of the app icon.
Name of the catalog this application comes from.
Must be at least 1 characters long
Whether this application is currently installed on the system.
The catalog train this application version belongs to.
Must be at least 1 characters long
"stable"
"enterprise"
Popularity ranking of this application. Lower numbers indicate higher popularity. null if not ranked.
Additional Properties of any type are allowed.
Type: object