It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

JIRA Java API vs Rest API

I'm writing an app for internal use that needs to collect data from a Jira Server. Basically, it will crawl the Jira server, starting with Projects and recursing down into Issues looking for specific bits of data.

Everything I've read seems to indicate that the REST API is best suited for this. In fact, everything I've read about the Java API seems to indicate that it's intended for writing plugins for JIRA, intended to be installed on the server.

The one thing that bothers me, though, is that the architecture diagram for the Java API here: has a "Common Component" labelled "REST". Is there a way to use that common component in my Java projects? I'm about to go down a path of creating a bunch of Jackson annotated objects so that I can Java-fy the REST API. I would love to avoid doing that work if it's already been done.



1 answer

0 votes

Correct, the Java API is internal, your code that uses that would be running inside a server.

REST is the external interface. It is provided by internal code though, so there's some commonality there.

Okay, so that's a "No" answer to my question? ie: ' [...] has a "Common Component" labelled "REST". Is there a way to use that common component in my Java projects?'

Yes, you can use that common component if your projects are running in a context that draws in the Jira libraries that provide it.

But I think what you're looking for is the flat "no".  Common component in the docs you're reading means "common within the context of the Jira application".  So if you're not coding within Jira (and you've said you are not), then they're no use to you.


Is it a correct assumption that the Rest API is wider than Java API? I have my Jira plugin and there is some functionality that is only available via Rest. For example I don’t find a way to list all the Agile sprints for a project via Java API while it exists in the Rest



Absolutely not.  The Java api can do anything in Jira that isn't prevented by the structure of the data.  The REST api is a limited set of calls that have been made available by Atlassian coding for them to be exposed.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Agile

The psychology of agile teams: what we learned

Last week Megan Cook, Head of Jira Software and Mahreen Khan, PhD, Organizational Psychology hosted an “ask me anything” session focused on the psychology of agile teams. We received 22 questions, 16...

83 views 0 7
Read article

Community Events

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

Find an event

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

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you