HP OneView REST API Reference

index/associations
index-associations.html[10/17/2013 10:35:57 AM]
GET https://{appl}/rest/index/associations?parentUri=/uri/1
URI: /rest/index/associations/resources
Method API
GET Gets the paginated collection of index association objects for X-API-VERSION = 2 or above based upon given parameters
Parameter Attributes Description
parentUri Optional The URI of the parent resource in the association relationship
childUri Optional The URI of the child resource in the association relationship
name Optional The name of the association
referenceUri Optional The reference URI to get the paginated collection
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 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 Number of resources to be returned before the reference URI resource
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.
category Optional Category of resources to be filtered
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.
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.