change sprint goal using rest api

Stephen Costanzo

Hello,

 

I'm using the 7.6.6 version of JIRA Server which implements Sprint Goals.

While using the get function, I can see the sprint goal, however, I am unable to change (or set) the sprint goal. I didn't know if I was missing something.

Side question: Can I do this for completed sprints prior to the upgrade to this version?

Thanks

curl --request POST  --header "Authorization: Basic cxxxxxxx="  --header 'Accept:application/json'  --header 'Content-Type:application/json'  --data '{"goal":"Sprint before reboot"}'  --url 'https://jira.xxxxxxxxx.com/rest/agile/1.0/sprint/867'

Andy Heinzer

Hi Stephen,

It appears that sprint goals were implemented in the 7.5.0 version of Jira Software Server per https://jira.atlassian.com/browse/JSWSERVER-7308

However a problem exists because the latest version of the Jira Software REST API that exists appears to be 7.3.1, which doesn't contain this feature yet.  Hence Atlassian does not yet have documentation on this specific REST endpoint in Jira Software Server yet.   I will try to help correct that problem.

 

 

In the meantime....

This is a feature that existed in Jira Cloud well before it existed in Jira Server, so let's try to look at the Cloud API for this info, check out https://developer.atlassian.com/cloud/jira/software/rest/#api-sprint-sprintId-post

It does appear this possible to do for planned or active sprints.  However there is also some notes on using that endpoint:

• Sprints that are in a closed state cannot be updated.
• A sprint can be started by updating the state to ‘active’. This requires the sprint to be in the ‘future’ state and have a startDate and endDate set.
• A sprint can be completed by updating the state to ‘closed’. This action requires the sprint to be in the ‘active’ state. This sets the completeDate to the time of the request.
• Other changes to state are not allowed.
• The completeDate field cannot be updated manually.

So you can't use this for closed sprints.  But you should be able to use this for active/planned sprints.  I believe the syntax should be the same in Jira server, even though this documentation is for Jira Cloud.

I hope this helps.

Andy