Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:

 


/ws/rest/Document?pageNumber=1&limit=10&filter=documentAmount(GT)100000 


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


Another example: 


/ws/rest/Vessel?filter=flag.countryCode(EQ)HK&pageNumber=4&limit=10

 


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


Note

Pagination is available from version 3.3 of the Dataloy API

...