ListResult
Base class for list results from collections
Base class for list results from collections.
JSON Example
{
"offset": 0,
"number_of_results": 0,
"total_result_count": 0,
"total_pages": 0,
"sort_ascending": false,
"sort_by": "string"
}
integer
offset
Optional
Offset pagination parameter used to exclude from a response the first N items of a resource collection. This reflects the offset provided in the request.
integer As int64
As int64
number_of_results
Optional
This is the number of results returned in the current page.
integer As int64
As int64
total_result_count
Optional
Total number of results found (across all pages), set only on first page.
integer As int64
As int64
total_pages
Optional
Total pages present, based on page_size.
boolean
sort_ascending
Optional
If true, results are sorted in ascending order.
string
sort_by
Optional
Field by which records are sorted.