HP OneView REST API Reference

index/resources
index-resources.html[10/17/2013 10:35:56 AM]
Updated: October 16, 2013 4:13
MDT
API Specifications Create Read Update Delete
/rest/index/resources GET
/rest/index/resources/** GET
/rest/index/resources/schema GET
Resource Model
IndexPaginatedCollection
IndexPaginatedCollectionV3
IndexResource
HP OneView REST API Reference
index/resources
The index/resources resource provides APIs for managing index resources, including retrieving, creating/updating, and
deleting index resources. To make searches faster, the index stores an index resource for each resource. Index resources
contain normal search parameters such as name, category, status, state, description, and so on. They also contain
attributes, with searchable data from the resource.
URI: /rest/index/resources
Method API
GET Gets a paginated list of index resources for given search. Optional parameters like userQuery, filter, reference URI
and padding can be used to filter the list of resources returned
Parameter Attributes Description
userQuery Optional The free form search string typed in by the user
category Optional A resource category to filter the results. Multiple category parameters can be
used to filter based on multiple categories. Multiple category works with the
OR operator
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.
query
Experimental This parameter is experimental for this release: While generally functional