JIRA SOAP API documenation?

Question

I'm building some custom tools to work against a JIRA install, and the exposed SOAP API is great, except that none of the arguments are named.

For example, the prototype for getIssue is:

RemoteIssue getIssue (string in0, string in1);

All of the SOAP RPC methods follow this convention, so without documentation I'm pretty hardpressed to figure out what to pass on a lot of these.

Does anyone know of a definitive API documentation guide?

Answer 1

Found the javadoc:

http://docs.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/index.html?com/atlassian/jira/rpc/soap/JiraSoapService.html

Answer 2

The javadoc link you found is the correct one. You should also know that not everything is exposed via the SOAP or RPC interfaces, but you can do just about anything using the REST interface. Unfortunately, the REST interface isn't well documented, but you can use an HTML traffic inspector tool (like Fiddler for IE) to grab the actual POST data sent to the server from the web interface and piece together the interface for the particular call you need. Not always the easiest way but it does work.

Answer 3

I've found that it's pretty simple to intuit what the parameters are supposed to be. Depending on how complicated you're going, you might be able to guess what you're supposed to pass.

There's one super important one though (this is Python with SOAPpy):

self.proxy = WSDL.Proxy( jiraUrl )
self.token = self.proxy.login(self.username, self.password)
...
issues = self.proxy.getIssuesFromFilter(self.token, args[0])

After getting the token from the login() method, you need to pass it in as a parameter to all of the other SOAP calls. After figuring that out, it's been pretty straightforward to figure out what the parameters should be (for example, getIssuesFromFilter should take the filterId as its other parameter)

Answer 4

See http://confluence.atlassian.com/display/JIRA/JIRA+RPC+Services for all JIRA RPC services