HP OneView REST API Reference

index/associations
index-associations.html[10/17/2013 10:35:57 AM]
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
AssociationPaginatedCollection Paginated collection of index resource association
Response Codes
REST API Response Codes
Examples
Get a paginated collection of index association objects for a given parentUri and association name. Specify sort and filter
parameters.
GET https://{appl}/rest/index/associations/resources?
parentUri=/uri/parent&name=ASSOCIATION_NAME&count=4&start=0&sort=state:desc&filter="_ownerid:perm"
The following example returns paginated collection of index association objects for given parentUri, association name, filters,
sorting and referenceUri
with padding
GET https://{appl}/rest/index/associations/resources?
parentUri=/uri/parent&name=ASSOCIATION_NAME&count=4&padding=5&referenceUri=/uri/referenceuri&sort=state:desc&filter="_ownerid:perm"
URI: /rest/index/associations/schema
Method API
GET Generates the association schema in JSON format
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
JsonSchema The JSON schema of the association
Response Codes
REST API Response Codes
Examples
Get the schema of the association, in JSON format: