Response parameters for page settings
The response parameters for page settings are the same among API functions.
| Items | Response parameters | Type |
Value |
|---|---|---|---|
| Is this the first page or not | first | Boolean |
• true: This is the first page. • false: This is not the first page. |
| Is this the last page or not | last | Boolean |
• true: This is the last page. • false: This is not the last page. |
|
Page number |
number | Integer | The first page is 0. |
| Item number | numberOfElements | Integer | |
| Number of items per page | size | Integer | |
| Sort order | sort | Array | [ {"direction":"string","property":"string", "ignoreCase":true,"nullHandling":"string", "descending":false,"ascending":true } ,...] |
| Total number of items | totalElements | Integer | |
| Total pages | totalPages | Integer |
The meaning of the contents of "sort" is as follows:
| Items | Response parameters | Type | Value |
|---|---|---|---|
| Sort direction | direction | String |
"ASC" | "DESC" • ASC: In ascending order • DESC: In descending order |
| Target of sort | property | String | Parameter name to be the target of the sort. |
| Distinguish upper case and lower case | ignoreCase | Boolean |
• true: Distinguish upper case and lower case • false: Does not distinguish upper case and lower case |
| Handling of a NULL | nullHandling | String |
"NATIVE" | "NULLS_FIRST" | "NULLS_LAST" • NATIVE: The NULL is treated as the first value. • NULLS_FIRST: The NULL is treated as the first value. • NULLS_LAST: The NULL is treated as the last value. |
| Descending | descending | Boolean |
• true: In descending order • false: In ascending order |
| Ascending | ascending | Boolean |
• true: In ascending order • false: In descending order |