🖍️
Dataloy VMS API Documentation
API Release 8.6
API Release 8.6
  • Dataloy VMS API
  • Dataloy Rest API
    • What is it?
    • Authentication / Authorization
    • Getting Started
    • Data Model
    • Filtering
    • Sorting
    • Pagination
    • Adjust Number of Fields to be Returned from a Request
    • Webhooks
      • Webhook example
      • Expressions Made Easy
      • Webhooks - New functionalities
    • Master data Objects
    • Attachments
    • Audit Log
  • User Guides
    • Accounting Integration API
      • Invoicing
      • Payments/Receipts
      • Voyages
      • Business Partners
      • Exchange Rates
      • Bunker Transactions
      • Actuals
      • Autopost Invoices
      • Accruals
    • Schedule API
    • Bunker Order Integration API
    • Service Order Integration API
    • Vessel Report
      • Overview
      • Legacy version (6.26 - 6.28)
      • Vessel report master data
    • Bunker Consumption API
    • Left join in API queries
    • Enterprise functionalities
      • Versioning
      • Endpoint access control
      • Data access control via target object
      • Data access control via target object and security role
      • Data access control at object level
      • Fields access control
      • Alert Scripts
      • Websockets
      • Bulk Deletion
      • Copy objects
      • OR and AND operators in API queries
      • Sub queries
      • XML Transformation
      • Expressions
      • Bulk Update
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Dataloy Rest API

Pagination

PreviousSortingNextAdjust Number of Fields to be Returned from a Request

Was this helpful?

To return a defined number of objects for any Dataloy resource it has to be specified in the URL the page number, pageNumber parameter, and the number of objects that the page has to contain, limit parameter. For example:

it will return the first page containing at max 10 Document objects having the property documentAmount greater than 100000. In the response will be added an header parameter called totalObjectsNumber that indicates the total number of objects of the endpoint.

From API 5.18 is possible to avoid to get totalObjectsNumber sending the HTTP header parameter noCount = YES, this will allow a bit better performance.

Another example:

it will return the fourth page containing at max 10 Vessels objects having the countryCode property equals to EQ.

/ws/rest/Document?pageNumber=1&limit=10&filter=documentAmount(GT)100000
/ws/rest/Vessel?filter=flag.countryCode(EQ)HK&pageNumber=4&limit=10