Requirements for the API implementing paged results

[Heer-Boaz]

There appears to be no description of the requirements on how to support pagination from the perspective of the API that is being invoked by Logic Apps.
Now, we are getting an "InvalidPageResponse", related to a property 'value' missing in the result body.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 560fac39-1341-6821-d1d6-635299c6971a
• Version Independent ID: 7a39683a-335a-285d-6d3b-d27f9ee97bcc
• Content: Get more data, items, or records with pagination - Azure Logic Apps
• Content Source: articles/logic-apps/logic-apps-exceed-default-page-size-with-pagination.md
• Service: logic-apps
• GitHub Login: @ecfan
• Microsoft Alias: estfan

[mike-urnun-msft]

Hi @Heer-Boaz Thank you for your feedback! We will review and update as appropriate.

[DixitArora-MSFT]

@ecfan Just checking if we need to define this.

[Heer-Boaz]

I've got it working by trial and error.
Unfortunately, the out-of-the-box support for paging has some limits (e.g. only the rows in value are part of the task output).

Requirements for returning paginated responses (JSON)

JSON-body of the response needs to include the properties:

• nextLink: the URI that contains the next paged result. This property should only be present in the body when there are more pages available. Otherwise, this property should not be present in the body.
• value: an array containing the results of the requested page. The objects that are returned in the response body are aggregated.

The HTTP-response code is 200.

Example paginated API responses

Response #1

{
  "property": "Hello",
  "nextLink": "http://localhost:7071/api/PaginationFunction?pagetoken=Boem",
  "value": [
    {
      "Name": "name1",
      "Description": "desc1"
    },
    {
      "Name": "name11",
      "Description": "desc11"
    }
  ]
}

Response #2

{
  "property": "Hello Boem",
  "nextLink": "http://localhost:7071/api/PaginationFunction?pagetoken=Klaar",
  "value": [
    {
      "Name": "name3",
      "Description": "desc3"
    }
  ]
}

Response #3

{
  "property": "Hello Klaar",
  "value": [
    {
      "Name": "name2",
      "Description": "desc2"
    },
    {
      "Name": "name22",
      "Description": "desc22"
    }
  ]
}

Example logic app task output

{
  "value": [
    {
      "Name": "name1",
      "Description": "desc1"
    },
    {
      "Name": "name11",
      "Description": "desc11"
    },
    {
      "Name": "name3",
      "Description": "desc3"
    },
    {
      "Name": "name2",
      "Description": "desc2"
    },
    {
      "Name": "name22",
      "Description": "desc22"
    }
  ]
}

[DixitArora-MSFT]

@Heer-Boaz I am glad that the issue is resolved. For now will proceed to close this thread. If there are further questions regarding this matter, please tag me in your reply. We will gladly continue the discussion and we will reopen the issue.

[ecfan]

@Heer-Boaz & @DixitArora-MSFT, thanks for raising this issue. I think adding this info would be useful, so I'll open a work item. Thanks again!

[robinhalabicki]

Any progress on this? Pagination only works if the Payload results have "value".

[mshparber]

My API (OKTA) returns rel="next" url in the RESPONSE HEADER.
Is this supported?

[mkilp91]

Unfortunately, the API I am using has the same issue as @mshparber. The "nextLink" and "value" keys are called "next" and "results" respectively in the model I am using.

I do have a work around, granted it is pretty annoying. That said, I am pretty new to programming so take it easy on me if this solution is a bit messy. Here are the steps:

1. Initialize variables: integer: "count"=1, integer: "offset"=0, array: "response"=[]. Make sure that count is initialized to be greater than 0. It will be reset after the HTTP action returns a response.
2. Create a Do Until loop where the condition is "@{variables('offset')}>@{variables('count')}"
3. Within the loop create your HTTP action and use limit and offset query parameters. For example, the URI is "https://{your endpoint}?limit=100&offset=@{variables('offset')}".
4. Add a Parse JSON action after the HTTP action. Content should come from the body of your HTTP request and then define your schema based on your API's model.
5. Append to array @{variables('response')}. Value=@{body('Parse_JSON')?['results'].
6. Set variable "count" from the value in the HTTP response.
7. Increment offset by the value you set your limit parameter to. In my case 100.

Once the offset exceeds the count, the loop will stop and you now have an array of your paginated JSON (response).

I really wish there was a way to tell the HTTP action that a key in your payload is the same as the value key the HTTP action uses to paginate responses. However, this workaround has been a viable solution in my automation development.

I hope this helps!