Accessing Sprint Data from Agile Boards (JIRA-Software) via Java-API or REST?

[davidgaidaTU]

Hello there,

I want to create a JIRA Plugin and need access to the sprints from an agile project (Scrum). 

I am confused about the recommendations of the API documentations, because both (Java API and REST) recommend to use REST-API for remote access, but are unclear about internal usage.

https://community.atlassian.com/t5/Answers-Developer-Questions/How-to-access-Greenhopper-Services-and-Managers/qaq-p/505399

What is the right way to get this data (sprint issues, number of sprint, ... )?

[Andy Heinzer]

While Jira Software does have a Java API, this has not been publicly documented since the Jira Agile versions (6.7.xx.x and before).  There is an existing bug for this missing documentation in https://jira.atlassian.com/browse/JSWSERVER-15321

In the case of creating a plugin, I could see scenarios of using either JAVA API or the REST API depending on what actions your plugin performs.  However I think the recommendation to use REST is not only because it is better documented, but also because it is better suited to function an an external endpoint that you can interface with Jira through. 

The Jira Software (formerly Agile) does have a list of the REST calls that were applicable in 7.0.4 over here: https://docs.atlassian.com/jira-software/REST/7.0.4/

I hope that the REST documentation on this will be helpful here.

Alternatively you could try to use the older Agile documentation on the JAVA API, such as in https://docs.atlassian.com/jira-software/6.7.7/

The problem with that is this does not account for all the changes to Jira Software since 7.0.0 and higher, so not only are there likely to be different classes in use here, but also possibly other features that are not yet totally documented yet.   Maybe this is not an issue, as the JAVA API for what you are looking for might still be the same.