Page

Page
Page

Collection of paging-related metadata to be included by composition via allOf. This type should be included in pageable responses to avoid duplicating these common properties. It is intended to be included by composition rather than inheritance. Because of this, it has no discriminator and should be embedded via allOf. See QueryResults for a reference usage.

JSON Example
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ]
}
integer
resultTotal
Optional

How many results there are in total (i.e., considering all pages).

integer
pageCount
Optional

How many pages there are in total.

integer
page
Optional

The page that was fetched, 1-indexed.

integer
pageSize
Optional

Result count for page that was fetched.

associations
Optional

Association info for each result.

Used By
Returned By