6.3 HP StoreAll Storage File System User Guide (TA768-96093, June 2013)

Wildcards
The StoreAll REST API provides three wildcards:
DescriptionWildcard
A single attribute name of * returns all system and custom
metadata attributes for the files and directories matching
the query.
*
A single attribute name of system::* returns all system
metadata attributes for the files and directories matching
the query. It does not include any custom metadata entries.
system::*
A single attribute name of custom::* returns all custom
(user-defined) metadata attributes for the files and
custom::*
directories matching the query. It does not include any
system metadata entries.
For wildcards that return system metadata attributes, the results will not include attributes that
describe deleted files (system::deleteTime, system::lastActivityTime, and
system::lastActivityReason).
Pagination
The StoreAll REST API provides a way for users to specify a portion of the total list of records (files
and directories) to return in the JSON query results.
DescriptionParameter
The skip parameter defines the number of records to skip
before returning any results. The value is zero-based. For
skip
example, skip=100 skips the first 100 records of the
results and the 101st record and later are returned. If the
total result set is less than 101, no results are returned.
The top parameter defines the maximum number of total
records to return. For example, top=2000 returns at most
2000 rows.
top
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 /<urlpath>[/[<pathname>]]?[version=1][attributes=<attr1>[,<attr2>,…]]
[&query=<query_attr><operator><query_value>][&recurse][&skip=<skip_records>]
[&top=<max_records>][&ordered] HTTP/1.1
The equivalent curl command format is the following on one line:
166 HTTP-REST API file-compatible mode shares