PageableObject

Example Json Object

 1{
 2  "paged": true,
 3  "unpaged": true,
 4  "pageNumber": 0,
 5  "pageSize": 0,
 6  "offset": 0,
 7  "sort": {
 8    "unsorted": true,
 9    "sorted": true,
10    "empty": true
11  }
12}

📄 Description: Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This object is essential for enhancing user experience by allowing businesses to manage and display data in a structured and accessible manner.

Properties

Name

Type

Required

Restrictions

Description

paged

boolean

false

none

Indicates whether the results should be returned in a paginated format, enhancing data retrieval efficiency for large datasets.

unpaged

boolean

false

none

Indicates whether the results should be returned without pagination, allowing for the retrieval of all available data in a single response.

pageNumber

integer(int32)

false

none

Page number for pagination

pageSize

integer(int32)

false

none

Number of items per page

offset

integer(int64)

false

none

Number of items to skip

sort

SortObject

false

none

Sort order specification