I've worked out how to get the list of boards, the list of sprints, the issues in a sprint, create a new board and add issues to a sprint. The last thing I'm stuck on is creating a sprint using GH REST. Using the rest browser and looking in the Chrome developer network tab I see various calls: * backlog/markers/add with {"rapidViewId":4} is called when I click Create Sprint * sprint/create/model is called after that? * sprint/create is called when I click Start Sprint What I'm using all this for is migrating data from one JIRA instance to another, so I really just want to create a sprint using the same data as an existing sprint in another JIRA. So, if you know how the GreenHopper REST API is supposed to be used to create sprints, please tell us all! This is GH 6.1.5 ~Matt

Matt, can please you share the scripts you created for doing this?

nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to create a Sprint using the GreenHopper REST API

Matt Doar_fellaq

I've worked out how to get the list of boards, the list of sprints, the issues in a sprint, create a new board and add issues to a sprint. The last thing I'm stuck on is creating a sprint using GH REST. Using the rest browser and looking in the Chrome developer network tab I see various calls:

backlog/markers/add with {"rapidViewId":4} is called when I click Create Sprint
sprint/create/model is called after that?
sprint/create is called when I click Start Sprint

What I'm using all this for is migrating data from one JIRA instance to another, so I really just want to create a sprint using the same data as an existing sprint in another JIRA.

So, if you know how the GreenHopper REST API is supposed to be used to create sprints, please tell us all! This is GH 6.1.5

~Matt

Accepted answers

All comments

Pedro Cora

Matt,

Take a look in the Developer Toolbox https://jira.atlassian.com/plugins/servlet/restbrowser#/com-pyxis-greenhopper-jira-greenhopper-rest-filter that may help.

Cheers,

Pedro

codelab expert

You can try to use this POST message (e.g.):

https://jira.atlassian.com/rest/greenhopper/1.0/sprint/create

Matt Doar_fellaq

The restbrowser is how I got the other methods working. But there's not enough documentation to make it clear which methods to use or what parameters to pass in. At the moment it's like reading an index in a book to try to understand the plot!

Matt Doar_fellaq

No, I think that's just used when the sprint is started.

sclowes

I'd suggest just taking a look at the GreenHopper code Matt, there's no better documentation than the code itself.

A sprint that has not been started is a marker, (i.e. backlog/markers/add), it's a ranked item in the backlog. A sprint is created (i.e. started) with /rest/greenhopper/1.0/sprint/create. Issues are added to the sprint by editing the Sprint custom field in the issues to contain the sprint (specifically it's ID).

Cheers,
Shaun

Matt Doar_fellaq

Here's what I've worked out. A board shows a list of issues. You order the issues. Creating a sprint is just a marker in that list of issues and you move issues up and down the list to make them appear below a marker. Markers have no dates and do not appear in the list of sprints. It's when you start a sprint it becomes an actual object including dates.

The problem I've run into with recreating GH data in another JIRA instance is that neither the UI nor the API let you add issues to completed sprints. So there's no easy way I can see to reproduce the history of a board, and I can only reproduce the current sprint(s).

I guess moving GH data is going to have to involve reading an activeobjects.xml file and inserting the data into the target database after some suitable tweaks to account for different project ids, sprint ids etc.

The other odd thing I've noticed is that if I define a board for project FOO, add some sprints and issues, then delete the board. The next time I create a board for the same project all the sprints are still there! Weird.

Matt Doar_fellaq

Yup, I'm in the code (there's no other way to find out what parameters to pass to the REST resources). But in the end the GH REST API doesn't have a way to add issues to closed sprints, so I can't use it to recreate GH data from one JIRA in another JIRA. So it's got to be either the GH Java API or SQL inserts.

sclowes

You're right, there's no way to assign an issue to a closed sprint from the UI. You'll need to edit the sprint custom field and create a back dated issue history entry to the issue to show that the sprint field was added to the issue before or during the sprint timeframe. You can't do backdating from the REST endpoints so you will need to use a Java plugin.

Please don't tweak the activeobjects.xml. Why not do something using the JIRA Importer (JIM) and the JSON import format (which is how the GreenHopper sample data itself is implemented). Take a look at https://bitbucket.org/nmuldoon/greenhopper-sample-data which is a Groovy script that can be run in Script Runner which I wrote a while ago which demonstrates how you can import issues in to historical sprints.

Cheers,
Shaun

Matt Doar_fellaq

Good idea, thanks.

Mikhail T

After installing the REST API Browser plugin, I can see the API-calls available in my JIRA instance. There are several calls listed under greenhopper/1.0/sprint/, but, unfortunately, greenhopper/1.0/sprint/create is not among them... Any idea, why? Our JIRA is a recent 6.1.7.

Thank you!

MattS

Take a look at the source code for jira-python where I added methods to do this after I worked out some of the REST calls

Bill Marten

If you know your rapid-board id, then you can create a new unstarted sprint by calling a POST request with:

http://<JIRA-server>/rest/greenhopper/1.0/sprint/<rapid-board-id>

(with no data attached)

Works as of JIRA Agile v6.3.6

Sorin Sbarnea (

Did anyone managed to find out how to add a sprint using REST ?! Agile 6.3+

Python-jira create_sprint() is broken, probably because atlassian removed the create verb.

Bill Marten

Yes see below...

"If you know your rapid-board id, then you can create a new unstarted sprint by calling a POST request with:

http://<JIRA-server>/rest/greenhopper/1.0/sprint/<rapid-board-id>

(with no data attached)

Works as of JIRA Agile v6.3.6"

Mikhail T

Bill, what will the name of the new sprint be after that?

Bill Marten

It'll be the Sprint that follows your previous one, i.e. if your last sprint was 'Sprint 32', the new one will be 'Sprint 33'.

You can then rename it to whatever you like of course.

Sorin Sbarnea (

Here is a feature request for solving the mess around working with sprints using the REST API:

https://jira.atlassian.com/browse/GHS-10848

The GH/Agile REST API related to Sprints is unstable and unecessarly complex. This bug is requesting a fix on it, so people can use it to automate the process, or to enable migrations from other systems.

At this moment, you can edit sprints but not their Status, even so the process of creating and editing them is anything but not simple.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

jira-software