HP OneView REST API Reference

logical-downlinks
logical-downlinks.html[10/17/2013 10:35:31 AM]
and filtering, and constrained by start and count parameters.
Parameter Attributes Description
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.
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.
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
LogicalDownlinkCollection An array of logical downlinks
Response Codes
REST API Response Codes
Examples
Get all the logical downlinks in the domain excluding any existing
ethernet networks:
GET https://{appl}/rest/logical-downlinks/withoutEthernet?
start=0&count=10
Get all the logical downlinks in the domain excluding any existing
ethernet networks:
GET https://{appl}/rest/logical-downlinks/withoutEthernet