JIRA Scripting API
Version 24.33 by Vincent Massol on 2016/05/29 19:29
 | Provides scripting access to JIRA using JIRA's Client API (JRJC) |
| Type | JAR |
| Category | API |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility |
|
Table of contents
Description
This module exposes the JRJC API to XWiki scripts. JRJC is a Java library to easily access a JIRA instance (Internally it uses the JIRA REST API).
Examples
Check also the JRJC Tutorial and JRJC Javadoc.
Example without being authenticated
Velocity:
{{velocity}}
#set ($client = $services.jira.getJiraRestClient("http://jira.xwiki.org/"))
#set ($pm = $services.jira.getNullProgressMonitor())
#set ($issue = $client.getIssueClient().getIssue("XWIKI-1000", $pm))
Summary: $issue.summary
{{/velocity}}
#set ($client = $services.jira.getJiraRestClient("http://jira.xwiki.org/"))
#set ($pm = $services.jira.getNullProgressMonitor())
#set ($issue = $client.getIssueClient().getIssue("XWIKI-1000", $pm))
Summary: $issue.summary
{{/velocity}}
Groovy:
{{groovy}}
import com.atlassian.jira.rest.client.*
def client = services.get("jira").getJiraRestClient("http://jira.xwiki.org/")
def pm = new NullProgressMonitor();
def issue = client.getIssueClient().getIssue("XWIKI-1000", pm);
println "Summary: ${issue.getSummary()}"
{{/groovy}}
import com.atlassian.jira.rest.client.*
def client = services.get("jira").getJiraRestClient("http://jira.xwiki.org/")
def pm = new NullProgressMonitor();
def issue = client.getIssueClient().getIssue("XWIKI-1000", pm);
println "Summary: ${issue.getSummary()}"
{{/groovy}}
Example with Authentication
Velocity:
{{velocity}}
#set ($client = $services.jira.getJiraRestClient("http://jira.xwiki.org/", "username", "password"))
...
{{/velocity}}
#set ($client = $services.jira.getJiraRestClient("http://jira.xwiki.org/", "username", "password"))
...
{{/velocity}}
Groovy:
{{groovy}}
...
def client = services.get("jira").getJiraRestClient("http://jira.xwiki.org/", "username", "password")
...
{{/groovy}}
...
def client = services.get("jira").getJiraRestClient("http://jira.xwiki.org/", "username", "password")
...
{{/groovy}}
Example to find all issues matching a JQL query
Velocity:
{{velocity}}
#set ($client = $services.jira.getJiraRestClient("http://jira.xwiki.org/"))
#set ($pm = $services.jira.getNullProgressMonitor())
|=Key
#foreach ($basicIssue in $client.getSearchClient().searchJql("project = XWIKI AND status = Closed and fixVersion in ('3.2 M1', '3.2 M2', '3.2 M3', '3.2 RC1', '3.2') ORDER BY priority DESC", $pm).getIssues())
|$basicIssue.getKey()
#end
{{/velocity}}
#set ($client = $services.jira.getJiraRestClient("http://jira.xwiki.org/"))
#set ($pm = $services.jira.getNullProgressMonitor())
|=Key
#foreach ($basicIssue in $client.getSearchClient().searchJql("project = XWIKI AND status = Closed and fixVersion in ('3.2 M1', '3.2 M2', '3.2 M3', '3.2 RC1', '3.2') ORDER BY priority DESC", $pm).getIssues())
|$basicIssue.getKey()
#end
{{/velocity}}
Groovy:
{{groovy}}
import com.atlassian.jira.rest.client.*
import com.atlassian.jira.rest.client.domain.*
def client = services.get("jira").getJiraRestClient("http://jira.xwiki.org/")
def pm = new NullProgressMonitor()
def issueClient = client.getIssueClient()
println "|=Key"
client.getSearchClient().searchJql("project = XWIKI AND status = Closed and fixVersion in ('3.2 M1', '3.2 M2', '3.2 M3', '3.2 RC1', '3.2') ORDER BY priority DESC", pm).getIssues().each() { basicIssue ->
println "|${basicIssue.getKey()}"
}
{{/groovy}}
import com.atlassian.jira.rest.client.*
import com.atlassian.jira.rest.client.domain.*
def client = services.get("jira").getJiraRestClient("http://jira.xwiki.org/")
def pm = new NullProgressMonitor()
def issueClient = client.getIssueClient()
println "|=Key"
client.getSearchClient().searchJql("project = XWIKI AND status = Closed and fixVersion in ('3.2 M1', '3.2 M2', '3.2 M3', '3.2 RC1', '3.2') ORDER BY priority DESC", pm).getIssues().each() { basicIssue ->
println "|${basicIssue.getKey()}"
}
{{/groovy}}
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.contrib.jira:jira-api 8.2):
- org.xwiki.contrib.jira:jira-config-api 8.2
- org.xwiki.commons:xwiki-commons-script 6.4
- org.xwiki.commons:xwiki-commons-properties 6.4
- com.atlassian.jira:jira-rest-java-client 1.0
