HP OneView REST API Reference

index/trees
index-trees.html[10/17/2013 10:35:58 AM]
count, the API attempts to return the specified number of
resources, however this may be limited due to response time
constraints and/or actual number of resources available to
return. The results include the total number of resources that
match the filter or query, the actual count returned, and
the URIs to go to the next page, previous page, or both. If
necessary, you can make several requests using the URI for
the next or previous page (or different start parameters) to
get the desired count.
padding Optional
referenceUri Optional
sort Optional The sort order of the returned data set. By default, the sort
order is based on the create time, with the oldest entry first.
query Experimental This parameter is experimental for this release: While
generally functional when used in simple cases, restrictions
might be noted in the implementation description.
If the query is supported, the following is the way it works. A
general query string that narrows the list of resources returned
by a multi-resource GET (read) request and DELETE (delete)
request. The default is no query (all resources are returned).
One advantage query has over filter is that it can have
embedded ORs. A single query parameter can do what would
take multiple parameters or multiple GET requests using
filter. Use query for more complex queries.
view Optional Return a specific subset of the attributes of the resource or
collection by specifying the name of a predefined view. The
default view is expand (show all attributes of the resource, and
all elements of collections or resources).
fields Optional Specifies which fields/columns should be returned in the
response
filter Experimental This parameter is experimental for this release: While
generally functional when used in simple cases, restrictions
might be noted in the implementation description.
A general filter/query string that narrows the list of resources
returned by a multi-resource GET (read) request and DELETE
(delete) request. The default is no filter (all resources are
returned).
Request Header Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
TreesPaginatedCollection The trees for the given search which contains
the hierarchy of
the relationship of multiple resource