6.5 HP StoreAll OS User Guide

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
/<urlpath>[/[<pathname>]]?[version=2&][attributes=<attr1>[,<attr2>,…]]
[&query=<query_attr><operator><query_value>][AND
<query_attr><operator><query_value>][&recurse][&skip=<skip_records>]
[&top=<max_records>][&ordered][&freshness][&bypoid] HTTP/1.1
The equivalent curl command format:
NOTE: The following command should be entered on one line.
curl -g "http[s]://<IP_address>:<port>/<urlpath>[/[<pathname>]]?
nl
[version=2&][attributes=<attr1>[,<attr2>,…]]&query=<query_attr><operator><query_value>
[AND
<query_attr><operator><query_value>][&recurse][&skip=<skip_records>][&top=<max_records>][&ordered]"
See “Using HTTP” (page 174) for information about the IP address, port, and URL path. If the
urlpath or pathname does not exist, HTTP status code 404 Not Found is returned.
DescriptionParameter
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 <urlpath>. Furthermore:
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 “Wildcards”
(page 233).
A system and/or custom metadata attribute to be compared against the value as the
query criterion.
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)
> (greater than)
>= (greater than or equal to)
Only for custom attributes and string-valued system attributes (for example,
system::path, system::tier):
~ (regular expression match)
!~ (does not match regular expression)
234 HTTP-REST API file-compatible mode shares