Issues may not be visible when using the REST API and pagination

XMLWordPrintable

    • Type: Suggestion
    • Resolution: Unresolved
    • None
    • Component/s: REST API
    • None
    • 1
    • 3

      In the following scenario, when running the following REST API query to return issues within a certain range of "Updated" dates.

      /rest/api/2/search?jql=(updated%3E=%272019/04/01%27%26%26updated%3C%272019/08/09%27)&Content-Type=application/json&fields=%27field1,%20field2,...%27
      

      It'll return the following data, as example:

      Key Updated
      SSD-1 01/Aug/2019
      SSD-2 01/Aug/2019
      SSD-3 01/Aug/2019
      SSD-4 01/Aug/2019
      SSD-5 01/Aug/2019
      SSD-6 01/Aug/2019
      SSD-7 01/Aug/2019
      SSD-8 01/Aug/2019
      SSD-9 01/Aug/2019

      When using maxResults=5, we have the following:

      /rest/api/2/search?jql=(updated%3E=%272019/04/01%27%26%26updated%3C%272019/08/09%27)&Content-Type=application/json&fields=%27field1,%20field2,...%27&maxResults=5
      
      Key Updated
      SSD-1 01/Aug/2019
      SSD-2 01/Aug/2019
      SSD-3 01/Aug/2019
      SSD-4 01/Aug/2019
      SSD-5 01/Aug/2019

      Before browsing to page 2 (startAt=5), issue SSD-5 is modified, resulting in the Updated field to be changed, therefore, making this issue outside of the query scope.

      Browsing to page 2, (startAt=5). We have the following output:

      /rest/api/2/search?jql=(updated%3E=%272019/04/01%27%26%26updated%3C%272019/08/09%27)&Content-Type=application/json&fields=%27field1,%20field2,...%27&maxResults=4&startAt=5
      
      Key Updated
      SSD-7 01/Aug/2019
      SSD-8 01/Aug/2019
      SSD-9 01/Aug/2019

      Notice that SSD-6 is not visible in page 2, since SSD-5 was modified, SSD-6 shifted to the previous page.

      Expected behaviour

      Jira should prevent this behaviour by making the returned issues consistent when using the REST API pagination.

            Assignee:
            Unassigned
            Reporter:
            Alex Stegani
            Votes:
            3 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: