HP OneView REST API Reference

index/trees
index-trees.html[10/17/2013 10:35:58 AM]
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
UriTrees The trees for the given search, showing the
hierarchy of
relationships for multiple resources
Response Codes
REST API Response Codes
Examples
Get all trees:
GET https://{appl}/rest/index/trees/minified
URI: /rest/index/trees/minified/**
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
treeLimit Optional The number of children and parents per association
details Optional If true all the attributes on the index resources will be returned, if
false a minimal set will be returned
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
UriTrees The tree for the given resource URI, showing the
hierarchy of