Pagination

The pagination support is built on top of the HATEOAS (Hypermedia as the Engine of Application State) principle, that uses hypermedia links in the API response contents. It allows the client to dynamically navigate to the appropriate resources by traversing the hypermedia links.

Navigating hypermedia links is conceptually the same as browsing through web pages by clicking previous or next page hyperlinks to achieve a final goal.

Below a sample of the model returned as a top level attributes for any API response that returns a list of objects.

PaginatedArray:
  title: Paginated Array
  description: Base class for results that may be paginated
  type: object
  properties:
    page:
      nextOffset:
        type: string
        description: Opaque identifier. Does not need to be numeric or have any specific pattern.
          Implementation specific
      prevOffset:
        type: string
        description: Opaque identifier. Does not need to be numeric or have any specific pattern.
          Implementation specific
      totalElements:
        type: integer
        description: Total number of elements
    links:
      description: Resource URLs for navigating result sets
      next:
        href:
          type: string
          format: uri-reference
          description: URL to invoke the action on the resource
        action:
          type: string
          description: HTTP Method to use for the request
        rel:
          description: Relation of this link to its containing entity
          type: string
        types:
          type: array
          items:
            type: string                
          description: Content-types that can be used in the Accept header          
      prev:
        href:
          type: string
          format: uri-reference
          description: URL to invoke the action on the resource
        action:
          type: string
          description: HTTP Method to use for the request
        rel:
          description: Relation of this link to its containing entity
          type: string
        types:
          type: array
          items:
            type: string                
          description: Content-types that can be used in the Accept header    
          

For more information about our APIs please refer to our API Reference