Creating an Issue in JIRA from other applications, like custom built UI for instance, is a common behaviour. It is pretty easy because JIRA provides us with the SOAP or XML/RPC interfaces. SOAP is recommended as it supports more operations which you might be using along with the Create!
Creating a JIRA SOAP client is pretty easy and is detailed in my previous tutorial. I am going to assume that you have the client created and a sample test done to ensure you are connected to your JIRA.
Creating a JIRA SOAP client is pretty easy and is detailed in my previous tutorial. I am going to assume that you have the client created and a sample test done to ensure you are connected to your JIRA.
The first step is to create a SOAP Session and get the authentication token by logging in using the SOAP method login. Again, please refer to the source code at the end of the tutorial or to my previous post on how to do that!
Before we proceed, let us have a quick look at the createIssue method in the SOAP API . As you can see, it accepts the token and a RemoteIssue object. The latter should be populated with all the necessary things needed for you issue, at-least all the mandatory fields!
This is how we populate the RemoteIssue:
Before we proceed, let us have a quick look at the createIssue method in the SOAP API . As you can see, it accepts the token and a RemoteIssue object. The latter should be populated with all the necessary things needed for you issue, at-least all the mandatory fields!
This is how we populate the RemoteIssue:
RemoteIssue issue = new RemoteIssue();
issue.setProject(PROJECT_KEY);
issue.setType(ISSUE_TYPE_ID);
issue.setSummary("Test Issue via J Tricks tutorial");
issue.setProject(PROJECT_KEY);
issue.setType(ISSUE_TYPE_ID);
issue.setSummary("Test Issue via J Tricks tutorial");
That should be the bare minimum unless you have some other fields set as mandatory. You can now invoke the createIssue method as follows:
RemoteIssue createdIssue = jiraSoapService.createIssue(authToken, issue);
System.out.println("\tSuccessfully created issue " + createdIssue.getKey());
System.out.println("\tSuccessfully created issue " + createdIssue.getKey());
The method accepts the RemoteIssue object we just created and returns a RemoteIssue for further processing or verification. In real life, you might need to add a lot more to the issue like 'Fix for versions' and 'Components'. Here is how we do that:
// Add remote compoments - Should be an array of RemoteComponent
RemoteComponent component = new RemoteComponent();
component.setId(COMPONENT_ID);
issue.setComponents(new RemoteComponent[] { component });
// Add remote versions - Should be an array of RemoteVersion
RemoteVersion version = new RemoteVersion();
version.setId(VERSION_ID);
issue.setFixVersions(new RemoteVersion[] { version });
RemoteComponent component = new RemoteComponent();
component.setId(COMPONENT_ID);
issue.setComponents(new RemoteComponent[] { component });
// Add remote versions - Should be an array of RemoteVersion
RemoteVersion version = new RemoteVersion();
version.setId(VERSION_ID);
issue.setFixVersions(new RemoteVersion[] { version });
Remember, the COMPONENT_ID and VERSION_ID should be the database unique ids and not name. You can find this in the URL while you are editing them or just by hovering over the action link.
If you need to apply a security level for the issue, you need to use the createIssueWithSecurityLevel method where you need to pass an additional parameter for the securityLevel.
May be one thing worth mentioning here! For the status, you shouldn't directly set it. Instead use the progressWorkflowAction method whcih we can look at at a later time.
That is it! We have the code for creating an issue via SOAP using the standard JIRA fields. Custom fields are not hard but it is better to cover in a separate post. Let us just make this short and sweet ;)
Download few examples with full source below. And don't forget to post your comments/feedback!
If you need to apply a security level for the issue, you need to use the createIssueWithSecurityLevel method where you need to pass an additional parameter for the securityLevel.
May be one thing worth mentioning here! For the status, you shouldn't directly set it. Instead use the progressWorkflowAction method whcih we can look at at a later time.
That is it! We have the code for creating an issue via SOAP using the standard JIRA fields. Custom fields are not hard but it is better to cover in a separate post. Let us just make this short and sweet ;)
Download few examples with full source below. And don't forget to post your comments/feedback!
| jira-soap-client.zip |
RSS Feed