Agile rest API for epic is not returning accurate results for the status

XMLWordPrintable

    • 1
    • Severity 3 - Minor

      Issue Summary

      Using the Get epics endpoint and querying for an specific status, the results are not consistent.

      Environment

      • Next-gen project

      Steps to Reproduce

      1. Create a next-gen project;
      2. Create two epics, set one with the "Done" status, and the other with another status;
      3. Run the following endpoint on the browser:
        https://<INSTANCE_NAME>.net/rest/agile/1.0/board/<BOARD_ID>/epic?done=false

        See the example on my test instance here.

      Expected Results

      Only the "Epic 1" should return.

      Actual Results

      Both Epics return as false.

      {
        "maxResults": 50,
        "startAt": 0,
        "isLast": true,
        "values": [
          {
            "id": 12378,
            "key": "RT-13",
            "self": "https://becktokceb.atlassian.net/rest/agile/1.0/epic/12378",
            "name": "",
            "summary": "Epic 1",
            "color": {
              "key": "color_1"
            },
            "done": false
          },
          {
            "id": 12379,
            "key": "RT-14",
            "self": "https://becktokceb.atlassian.net/rest/agile/1.0/epic/12379",
            "name": "",
            "summary": "Epic 2",
            "color": {
              "key": "color_1"
            },
            "done": false
          }
        ]
      }
      

      Workaround

      Use another endpoint to get the proper status for the specific Epics, examples:

      • https://<INSTANCE_NAME>.atlassian.net/rest/agile/1.0/issue/<EPIC_KEY>?fields=status
      • https://<INSTANCE_NAME>.atlassian.net/rest/api/3/issue/<EPIC_KEY>?fields=status

            Assignee:
            Unassigned
            Reporter:
            Fábio W. [Atlassian]
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: