External Paging

How do I use the external query to allow for paging override?

First, create an input that is a JSON data type.

In this example, we have added a JSON input named external to the GET all users API endpoint.

Secondly, open the Query all Records function. In the Output tab, under return enable paging.

In the Output tab of the Query all Records function, click the pencil icon next to Return to enable paging.
Select the checkbox next to enable paging and click save.

​

Next, link the configuration in the External query tab to the JSON input using the drop down menu. Additionally, select "Allow Page Override" and "Allow Per Page Override" permission. (Note: you can choose just one between Page Override and Per Page Override or both. Determine what works best for your use case).

In this example, we linked up the external configuration with the JSON input "external." Then we selected permissions to allow page and per page override. Note: you can choose one or the other or both depending on your requirements.

Now, we are ready do paging by the external query. Because the external query takes a JSON input, we must format the input in a JSON like the examples below.

The below JSON object uses both Page Override and Per Page Override. It will return page 1 and 2 items per page:

{
"external":{"page":1, "per_page":2}
}
​

The below JSON input would be used for just Page Override:

{
"external":{"page":1}
}
​

The below JSON input would be used for just Per Page Override:

{
"external":{"per_page":2}
}
​