Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.
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.
Unique identifier for the iSCSI extent.
Name of the iSCSI extent.
Must be at least 1 characters long
Must be at most 64 characters long
Type of the extent storage backend.
Disk device to use for the extent or null if using a file.
Serial number for the extent or null to auto-generate.
File path for file-based extents or null if using a disk.
Size of the file-based extent in bytes.
Block size for the extent in bytes.
Whether to use physical block size reporting.
Available space threshold percentage or null to disable.
Value must be greater or equal to 1 and lesser or equal to 99
Optional comment describing the extent.
Network Address Authority (NAA) identifier for the extent.
Must be at most 34 characters long
Whether to enable insecure Third Party Copy (TPC) operations.
Whether to enable Xen compatibility mode.
Reported RPM type for the extent.
Whether the extent is read-only.
Whether the extent is enabled and available for use.
Vendor string reported by the extent.
Product ID string for the extent or null for default.
Must be at least 1 characters long
Must be at most 16 characters long
Read-only value indicating whether the iscsi extent is located on a locked dataset.
true: The extent is in a locked dataset.false: The extent is not in a locked dataset.null: Lock status is not available because path locking information was not requested.