By default, the RESTful v2 API will return up to 1000 resources starting at the
first row of the result set. If the total resource count is larger than the
default limit, requests can use the limit
and
offset
query parameters to page through the complete
list.
The count
field is set to the number of resources returned. To
facilitate iteration, prev
and next
links are
included when the total resource count exceeds the specified
limit
. The data
field is set to an array
containing the list of resources. If no resources were found matching the
request, an empty array is returned.
The maximum value for limit
is 100,000.
Request
GET http://{Address_Manager_IP}/api/v2/locations?limit=2000&offset=1000
Authorization: Basic {basicAuthenticationCredentials}
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"count": 2000,
"_links": {
"prev": {
"href": "/api/v2/locations?offset=0&limit=1000"
},
"next": {
"href": "/api/v2/locations?offset=3000&limit=2000"
}
},
"data": [
...
]
}
Name |
Purpose |
Syntax |
Operators |
Examples |
offset | Pagination: Resource (row) offset | offset=<row number> | offset=10 | |
limit | Pagination: Result set max count | limit=<count> | limit=1000 |