HP OneView REST API Reference

interconnects
interconnects.html[10/17/2013 10:35:37 AM]
Response Codes
REST API Response Codes
Examples
This example assumes you have 6 interconnects, and want to use pagination to retrieve all 6. To get 3
pages with the
recommended 2 interconnects per page, follow these steps:
1. Get the first page of the 2 interconnects in the domain with their port information:
GET https://{appl}/rest/interconnects?start=0&count=2
2. Get the second page:
GET https://{appl}/rest/interconnects?start=2&count=2
3. Get the last page:
GET https://{appl}/rest/interconnects?start=4&count=2
Note: the "total" property in the InterconnectCollection returned from the call contains
the total number of pages that the query will return. This value can be used to determine how many
calls you need to make to get all the results. Alternatively, you can make calls in a loop until
the nextPageUri property in the InterconnectCollection is null which indicates there are
no more resources to retrieve.
URI: /rest/interconnects/schema
Method API
GET Gets the JSON schema for the interconnect.
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 for this resource
Response Codes
REST API Response Codes
Examples
Get the JSON schema for the resource:
GET https://{appl}/rest/interconnects/schema
URI: /rest/interconnects/{id}
Method API
GET Gets an interconnect with ports.
Parameter Attributes Description
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
Interconnect The requested interconnect with ports
Response Codes
REST API Response Codes
Examples
Get the interconnect that matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20:
GET https://{appl}/rest/interconnects/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20
URI: /rest/interconnects/{id}/configuration
Method API