beautypg.com

Wildcards, Freshness, Pagination – HP StoreAll Storage User Manual

Page 233

background image

Wildcards

The StoreAll REST API provides three wildcards:

Description

Wildcard

In bypoid mode, a single attribute name of * returns all
system and custom metadata attributes for the files and
directories matching the query.

*

In default/bypath mode, the following system metadata
attributes are not returned: system::deleteTime and
system::poid

. The system::poid can be specifically

requested in default mode.

In bypoid mode, a single attribute name of system::*
returns all system metadata attributes for the files and

system::*

directories matching the query. It does not include any
custom metadata entries.

In default/bypath mode, the following system metadata
attributes are not returned: system::deleteTime and
system::poid

. The system::poid can be specifically

requested in default mode.

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.

Freshness

The StoreAll REST API provides a way for users to read the freshness information. See details in

“Freshness” (page 305)

.

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.

Description

Parameter

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.

Metadata queries 233