XML element Page

Name: Page

Models a list of items which make a page for API client. It includes list of 'typedBean' items, number of total pages in the query request, current page number and some additional metadata like time needed to complete the request and last update time.

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.Page",
   "absoluteTotal": <Number>,
   "completedIn": <Number>,
   "filteredTotal": <Number>,
   "lastUpdatedTime": DateTime,
   "limit": <Number>,
   "next": <String>,
   "offset": <Number>,
   "offsetMatchFound": <Boolean>,
   "overflow": <Boolean>,
   "page": <Number>,
   "pageTotal": <Number>,
   "prev": <String>,
   "total": <Number>,
   "items": [?],
}

Elements
Name	Type	Description
typedBean (wrapped by items)	xsd:list[?]	List of outgoing items

Attributes
Name	Type	Description
absoluteTotal	xsd:long	The absolute number of requested objects without any qualifications including filtering, active, or deleted.
completedIn	xsd:long	Time in milliseconds indicating how long it took to serve the request
filteredTotal	xsd:long	The number of objects as specified by the filter. If no filter was requested, it would be same as total.
lastUpdatedTime	DateTime	The time when the page was accesed.
limit	xsd:int	The client requested limit for the number of items in a page. Default is 2000.
next	xsd:string	The URL query string to fetch the next page.
offset	xsd:int	The client requested index of an item in the page. Offset could be provided as follows offset= offset=name: offset=position:
offsetMatchFound	xsd:boolean	Indicates if the requested item/(s) is/are found. For example, in case of GET VM call offset could be provided as "offset=name:"; OffsetMatchFound will be 'True' if requested VM(s) is found, 'False' otherwise
overflow	xsd:boolean	A flag giving notice the amount of data did not fit into the given specified or default offset.
page	xsd:int	The current page number.
pageTotal	xsd:int	The total number of pages available.
prev	xsd:string	The URL query string to fetch the previous page.
total	xsd:long	The number of active objects.