greenhopper rest api, listing all issues in a sprint

Hi I am trying to use the rest api to get all the issues within a sprint.

I have got the sprint id from:

server:8080/rest/greenhopper/1.0/sprints/1

which returned {"id":4,"name":"Sprint 120132","closed":false}

using the sprint id as 4 I tried:

server:8080/rest/greenhopper/1.0/sprint/4/issues/list

But this is not correct.

5 answers

1 accepted

13 votes
Accepted answer

Hi,

First you need to get the rapidview ID for that sprint, here are the steps:

  1. Run /rest/greenhopper/1.0/rapidview to get list of rapid views with the IDs.
  2. After you get the rapid view ID, you will need to get list of sprints in that rapid view by running /rest/greenhopper/1.0/sprints/{rapidViewId}
  3. After obtaining the Sprint ID, you can run /rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId={rapidViewId}&sprintId={sprintID} to get list of issues for that sprint.

Hope it helps !

Omar

The sprintreport resource is the best I've found for this. However be aware that the lists of issues are in subsets: puntedIssues, completedIssues, etc

Hi. help me, please.

How to get a 'Issues Not Completed' in the sprints?

Are there Greenhopper REST API docs somewhere?

In the returned JSON that the sprintreport returns, there's an "incompletedIssues" array, that should be helpful.

Also, for the Greenhopper REST API, this is the best resource I could find:

https://jira.atlassian.com/plugins/servlet/restbrowser#/com-pyxis-greenhopper-jira-greenhopper-rest-filter

Omar, I was unable to get your route for sprints by rapid board to work. I checked the documentation and the route is actually rest/greenhopper/1.0/sprintquery/:myRapidBoardId where the segment value "sprintquery" differs from "sprints". Could be a version thing but at any rate in case anyone else is struggling with this hopefully my comment will help.

Hi, @Andrew Sandefer, which documentation did you check? And @Omar, where do you get those knowledge about the greenhopper API from? I googled a lot and did not find a good documentation for using greenhopper rest api. Can you point me to somewhere?

@Kaiyu Zheng - go to https://jira.atlassian.com/plugins/servlet/restbrowser#/ and take a look at the API Browser. There are also several getting started articles as well that can be found at https://developer.atlassian.com/jiradev/ Thanks and good luck! Andy

Hi Andy, Thanks! I looked around in the api browser, but didn't find rules like rapid/charts/sprintreport?rapidViewId={rapidViewId}&sprintId={sprintID}. Can you, as an example, point me to where this rule is found? I really appreciate it

@Andrew Sandefer

Thanks. I get it. I have to uncheckt the "Show only Public APIs"

@Kaiyu Zheng Could you Please help me to get the all the sprints. I follwed the above steps i am able to get rapidviews. but with that is i am not getting the all the sprints. below is my output. rapid views::{"views":[{"id":1,"name":"Sample Scrum Project","canEdit":true,"sprintSupportEnabled":true,"showDaysInColumn":false},{"id":2,"name":"test","canEdit":true,"sprintSupportEnabled":true,"showDaysInColumn":false}]} All sprints::{"message":"null for uri: http://172.16.0.32:8080/rest/greenhopper/1.0/sprints/2","status-code":404}

I've found that the easiest view of this is straight from the JIRA issues endpoint:

/rest/api/latest/search?jql=sprint%3D<SPRINT_ID>&fields=<FIELDS YOU WANT>&maxResults=<SOME REASONABLE LIMIT>

Just for reference, this is the actual Greenhopper / JIRA agile API list: https://jira.atlassian.com/plugins/servlet/restbrowser#/search/greenhopper

I did not find a refence, meaning one with description of what each API does.

Aren't the sprints project related objects? They should be retrievable via projectkey.

As far as I know, sprints are not project-specific as they can span multiple projects.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published 11 hours ago in Agile

Try the new Jira Cloud add-on for Google Sheets

Hi Atlassian community, I work on the product integration team at Atlassian and I am very excited to announce the early access program for the Jira Cloud add-on for Google Sheets. This add-on giv...

122 views 1 6
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you