HP OneView REST API Reference

index/trees
index-trees.html[10/17/2013 10:35:58 AM]
Method API
GET Gets the tree for a specified resource
Parameter Attributes Description
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
childLimit Optional
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
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
AggregatedTree The tree for the given resource URI, showing the
hierarchy of
relationship for multiple resources
Response Codes
REST API Response Codes
Examples
Get the tree for a specified resource URI:
GET https://{appl}/rest/index/trees/aggregated/<uri to resource>
URI: /rest/index/trees/minified
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