HP OneView REST API Reference

index/trees
index-trees.html[10/17/2013 10:35:58 AM]
Updated: October 16, 2013 4:13
MDT
API Specifications Create Read Update Delete
/rest/index/trees GET
/rest/index/trees/** GET
/rest/index/trees/aggregated/** GET
/rest/index/trees/minified GET
/rest/index/trees/minified/** GET
/rest/index/trees/schema GET
Resource Model
IndexResource
Tree
Trees
TreesPaginatedCollection
UriTree
UriTrees
TreeLink
AggregatedTree
HP OneView REST API Reference
index/trees
The index/trees resource provides APIs for getting index trees for specified searches. Index trees show the hierarchy of
relationships for multiple resources.
URI: /rest/index/trees
Method API
GET Gets the trees for a given search
Parameter Attributes Description
userQuery Optional The free form search string typed in by the user
category Optional A resource category to filter the results by
childDepth Optional The depth of children to return. A depth of 2 would return the
given resource's children and the children of its children
parentDepth Optional The depth of parents to return. A depth of 2 would return the
given resource's parents and the parents of its parents
details Optional If true all the attributes on the index resources will be returned,
if false a minimal set will be returned
start Optional The 0-based index of the first resource to return (start=0
starts with the first available resource). If the specified count
does not return all resources within the maximum allowed time
(see count), use the start parameter to view additional
resource pages. The default value for start is 0 (first
available resource).
count Optional Optional parameter that specifies the number of resources to
return from each API invocation. The number of resources
returned on each call is referred to as a page. If you specify a