q | null | | Example: q=name:{name} |
| A standard query parameter is used to search for specific values. | | | |
| Searching for items by string-based properties: | | | |
| By a field value: q=access:PUBLIC, where access is the field name, and PUBLIC is its desired value. | | | |
| Searching for items by a number-based property: | | | |
| With a specific value: q=details.bytes:200 | | | |
| With a value greater than: q=details.bytes:>200 | | | |
| With a value lower than: q=details.bytes:<200 | | | |
| With a value greater than or equal to: q=details.bytes:>=200 | | | |
| With a value lower than or equal to: q=details.bytes:<=200 | | | |
| With a value within a range of values: q=details.bytes:(>=100 AND <=200), where details.bytes is the name of a number-based field, and 200 is its querying value. | | | |
| Searching for items by a date-based property: All numer-based property queries are also valid for dates. In that case, the date should be placed within double quotes: q=metadata.createdAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z") | | | |
| Searching for items with a nonexistent or empty property: q=details.filename:null, where details.filename is the field that has its value set to null. | | | |
| Searching for items with an existing property: q=details:exists, where details is the field that has a non-empty value. | | | |
| Searching for items by multiple specific values: q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), where id is the field name, and strings within the brackets are the desired values. | | | |
| Searching for items by multiple fields: q=id:5c3325baa9812100098ff48f access:PUBLIC, where id and access are field names. All objects that contain the specified values are returned. Multiple fields (separated by spaces) can be specified. Multiple values for each field can also be specified in a format presented earlier. | | | |
| Searching for items with string-based properties conforming to a regex: q=id:~ABCD12 or q=id:(~AB CD) - in the case of searching for strings with a space, where id is the name of the field and ABCD12 or AB CD are its querying regular expressions. | | | |
sort | null | | Example: sort=name,metadata.createdAt:desc |
| Fields to sort the response data by following the order of the parameters from left to right. Can contain multiple fields in the following format: field name:sort direction, separated by a comma. The colon preceding the sort direction parameter is optional, and the descending order is taken only if it is equal to desc or DESC. The ascending order is assumed in any other case. | | | |
pageSize | null | | integer >= 1 |
| Default: 16 | | | |
| The number of documents being retrieved on the page. | | | |
pageNumber | null | | integer >= 1 |
| Default: 1 | | | |
| The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1. | | | |