Http syntax – HP StoreAll Storage User Manual
Page 185
The skip and top parameters can be combined. For example, supplying both skip=100 and
top=2000
returns records 101 through 2100. By combining these two parameters, the user can
absorb a large result set in chunks, for example, records 1-2000, 2001-4000, and so on.
The following limitations apply:
•
Every query will be executed in full, even if only a subset of results is returned. For some
queries, this may place a substantive load on the system. Keeping top values as large as
possible will limit this load.
•
Because a query is executed for every request, there may be inconsistencies in query results
if files are created or deleted between API requests.
By default, if the skip parameter is not supplied, the results will not skip any records. Similarly,
if the top parameter is not supplied, the results will contain all records.
HTTP syntax
The HTTP request line format is the following on one line:
GET /
[&query=
[&top=
The equivalent curl command format is the following on one line:
curl -g "http[s]://
nl
[version=1][attributes=
nl
[&recurse][&skip=
See
for information about the IP address, port, and URL path. If the
urlpath
or pathname does not exist, a JSON output of no results is returned (see the
), and the HTTP status code 200 (OK) is returned rather than an HTTP
error such as 404 (Not Found).
Description
Parameter
The name of the existing file or directory on the HTTP share, if querying metadata of a
single file/directory. If not present, the query applies to the
pathname
•
Directory pathnames must end in a trailing slash /.
•
If the &recurse identifier is supplied for a directory, the query applies to the entire
directory tree: the directory itself, all files in that directory, and all subdirectories
recursively.
•
If the &recurse identifier is not supplied and the pathname is for a directory, the
query operates only on the given directory and all files in that directory or directory
of files, but not subdirectories.
•
If the pathname is for a file, the query applies only to the file
A comma-separated list of system and/or custom metadata attribute names to be returned
in the JSON response for each file or directory matching the query criterion. The special
attr[n]
attribute names *, system::*, and custom::* are described under
A system and/or custom metadata attribute to be compared against the value as the
query criterion. Only one attribute can be listed per command.
query_attr
The query operation to perform against the query_attr and value, one of:
operator
=
(equals exactly)
!=
(does not equal)
<
(less than)
<=
(less than or equal to)
StoreAll REST API 185