Pagination TimeXtender REST Data Source (5.0)

Hi @jorisdl 

I have been a bit slow with the REST guides lately. So I don’t have it in a guide yet. However it is possible to do so if there is something like a page and page size parameter.

There is this free API called https://www.openbrewerydb.org/documentation

It has an endpoint that can handle a page and a page_size parameter like this.

https://api.openbrewerydb.org/v1/breweries?page=15&per_page=3

This info is not saved in the headers or in some meta data for each page. So I don’t know he max page. 

We have an option for increasing a number on each iteration. To do so add a query parameter with the value {TX_NextPage}. 

For me the pagination is set up like so.

I also made a generic stop condition as you can see. {*/*/*}[1] means that it searches for anything in the page after the first three levels and stops if it finds nothing.

An important thing is that the query parameters need to be the correct case setting, so if I added the parameter as Page, it would not work, only page does.

As mentioned it also had a page_size parameter, but I added that to the endpoint.

It does not apply the pagination on the first call, only the second and as the default page_size is 50 it would not give back the correct amount of rows as the first call would be

https://api.openbrewerydb.org/v1/breweries

Then the second call would be

https://api.openbrewerydb.org/v1/breweries?page=2&per_page=200

So that is why it is added to the endpoint to be sure all calls are done with the correct amount of rows per page.

If your API needs a offset and a limit, which is also a common occurrence, you can use the {TX_NextPage} option in sql queries to increase it with an amount on each iteration.

For example like this.

You can see the SQL expression is the pagination field * the amount of rows I want each call to have.

I then apply the {offsetValue} as the query parameter. Similar to the other I got a $limit parameter on the actual endpoint.