HP OneView REST API Reference
index/resources
index-resources.html[10/17/2013 10:35:56 AM]
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
referenceUri Optional The reference URI to get the paginated collection
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
IndexPaginatedCollectionV3 Paginated list of index resources with unfiltered total
resource count
Response Codes
REST API Response Codes
Examples
This example returns all resources with "category=appliance",
"referenceUri=/uri/indexResource/60" with "padding=5" and "count=10", sorted by name
in ascending order with unfiltered total count
GET https://{appl}/rest/index/resources?
category=appliance&padding=5&referenceUri=/uri/indexResource/60&count=10&sort=name:asc
URI: /rest/index/resources/**
Method API
GET Gets the IndexResource for given resource URI
Parameter Attributes Description