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.
Unique identifier for the ACL template.
Whether this is a built-in system template or user-created.
Human-readable name for the ACL template.
ACL type this template provides.
Array of Access Control Entries defined by this template.
Subject type for this ACE.
owner@: File/directory ownergroup@: File/directory primary groupeveryone@: All usersUSER: Specific user accountGROUP: Specific groupAccess control type.
ALLOW: Grant the specified permissionsDENY: Explicitly deny the specified permissionsPermissions granted or denied by this ACE.
Permission to read file data or list directory contents.
Permission to write file data or create files in directory.
Permission to append data to files or create subdirectories.
Permission to read named attributes (extended attributes).
Permission to write named attributes (extended attributes).
Permission to execute files or traverse directories.
Permission to delete the file or directory.
Permission to delete child files within a directory.
Permission to read basic file attributes (size, timestamps, etc.).
Permission to write basic file attributes.
Permission to read the Access Control List.
Permission to modify the Access Control List.
Permission to change the file owner.
Permission to use the file/directory as a synchronization primitive.
Basic permission level for NFS4 ACE.
FULL_CONTROL: Full read, write, execute, and administrative permissionsMODIFY: Read, write, and execute permissionsREAD: Read-only permissionsTRAVERSE: Execute/traverse permissions onlyInheritance and other behavioral flags for this ACE.
Apply this ACE to files within directories.
Apply this ACE to subdirectories within directories.
Do not propagate inheritance beyond immediate children.
This ACE only affects inheritance, not the object itself.
This ACE was inherited from a parent directory.
Basic inheritance behavior for NFS4 ACE.
INHERIT: Apply to child files and directoriesNOINHERIT: Do not apply to child objectsUID or GID when tag is "USER" or "GROUP". null for special entries.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Username or group name when tag is "USER" or "GROUP". null for special entries.
Must be at least 1 characters long
Subject type for this POSIX ACE.
USER_OBJ: File/directory ownerGROUP_OBJ: File/directory primary groupOTHER: All other usersMASK: Maximum permissions for named users and groupsUSER: Specific user accountGROUP: Specific groupRead, write, and execute permissions for this ACE.
No Additional PropertiesPermission to read file contents or list directory contents.
Permission to write file contents or create/delete files in directory.
Permission to execute files or traverse directories.
Whether this is a default ACE that applies to newly created child objects.
Numeric user or group ID when tag is USER or GROUP. null for object entries.
Value must be greater or equal to -1 and lesser or equal to 2147483647
Username or group name when tag is USER or GROUP. null for object entries.
Must be at least 1 characters long
Optional descriptive comment about the template's purpose.
Unique identifier for the ACL template.
Whether this is a built-in system template or user-created.
Human-readable name for the ACL template.
ACL type this template provides.
Array of Access Control Entries defined by this template.
Optional descriptive comment about the template's purpose.