How do you create a scrum Board using the Java api?

I am using the Jira SDK to create a plugin which will automate the process of creating my default project setup. A part of this default setup includes a scrum board. I've been unable to find any examples of creating a scrum board through the SDK, so I've been trying to figure out the process by piecing together the relevant classes.

I've been trying stuff like this:

// createBoard creates a new scrum board for a project
static String createBoard(ApplicationUser user, String projectKey)
// get Jira Components
ProjectManager projectManager = ComponentAccessor.getProjectManager();
BoardService boardService = ComponentAccessor.getComponent(BoardService.class);
SearchRequestService searchRequestService = ComponentAccessor.getComponent(SearchRequestService.class);
JiraServiceContext ctx = new JiraServiceContextImpl(user);
// get the project the board is for
Project project = projectManager.getProjectObjByKey(projectKey);
// build a search request
JqlQueryBuilder builder = JqlQueryBuilder.newBuilder();
Query query = builder.buildQuery();
SearchRequest searchRequest = new SearchRequest(query);
// set the name of the filter
searchRequest.setName("Filter for " + project.getName());
// set the permission of the filter
SharePermission permission = new SharePermissionImpl(ShareType.Name.GLOBAL,"","");
Set<SharePermission> permissions = new HashSet<>();
SharePermissions sharePermissions = new SharePermissions(permissions);
// set the owner of the filter
// create the filter
SearchRequest newSearchRequest = searchRequestService.createFilter(ctx,searchRequest,true);
Long filterId = newSearchRequest.getId();
// construct Board jql
String jql = "project = AAP AND name = Board AND type = scrum AND filterId = " + filterId;
// create Board object
BoardCreationData data = new BoardCreationData.Builder().projectId(project.getId()).jql(jql).build();
ServiceOutcome<Board> outcome = boardService.createBoard(user,data);
// if successful, return no error messages
return null;
catch (Exception e)
// return any error messages
return e.getMessage();

So far, I have not been able to create scrum board.

It seems like the classes and functions are there, it should be possible to create a scrum board in this way. But so far, I haven't been able to, and I haven't found any examples showing how to.


2 answers

Have you made any progress on this, Kirk?  I am attempting to do something very similar and, though I see no errors generated during the Board creation, I don't see that the Board exists anywhere.

Sorry to say, I have not made it any further than generating the invisible Board object. I have searched for assistance in several ways, and though this question did not get any reply, what I am typically told is to use a third party program. These programs are not free, and they are also Jira plugins. So there is some way to do it, but I have not figured it out.


In case you might want to know, here is one of those third party programs:



As discussed internally with an app developer, here's my answer for board retrieval. Hope this helps those in need of this info:


1. On your first creation of your plugin, make sure that Jira Software OBR is installed so you have all the software maven dependencies available to you
# In your {{pom.xml}} add the greenhopper as such:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns=""


<name>Example Company</name>

<description>This is the com.anne:AnneJiraPlugin plugin for Atlassian JIRA.</description>

<!-- Add dependency on jira-core if you want access to JIRA implementation classes as well as the sanctioned API. -->
<!-- This is not normally recommended, but may be required eg when migrating a plugin originally developed against JIRA 4.x -->





<!-- Uncomment to use TestKit in your project. Details at -->
<!-- You can read more about TestKit at -->



<!-- Uncomment to install TestKit backdoor in JIRA. -->

<!-- See here for an explanation of default instructions: -->
<!-- -->

<!-- Add package to export here -->

<!-- Add package import here -->

<!-- Ensure plugin is spring powered -->


<!-- This key is used to keep the consistency between the key in atlassian-plugin.xml and the key to generate bundle. -->
<!-- TestKit version 6.x for JIRA 6.x -->



2. I tested my retrieval by creating a private REST endpoint, this is what my board retrieval looks like:


import com.atlassian.greenhopper.model.rapid.RapidView;
import com.atlassian.greenhopper.service.ServiceOutcome;
import com.atlassian.greenhopper.service.rapid.view.RapidViewService;
import com.atlassian.jira.component.ComponentAccessor;
import com.atlassian.jira.user.ApplicationUser;


public class BoardRest{

private JiraAuthenticationContext jiraAuthenticationContext = ComponentAccessor.getJiraAuthenticationContext();
private RapidViewService rapidViewService = (RapidViewService) ComponentAccessor.getOSGiComponentInstanceOfType(RapidViewService.class);

public Response getBoard() {
ApplicationUser user = jiraAuthenticationContext.getLoggedInUser();

ServiceOutcome<RapidView> rapidView = rapidViewService.getRapidView(user, Long.valueOf(1));


return Response.ok(rapidView.getValue().getName()).build();
- This should return the Kanban Name (see screenshot)


3. atlassian-plugin.xml looks like this:

<atlassian-plugin key="${atlassian.plugin.key}" name="${}" plugins-version="2">
<vendor name="${}" url="${project.organization.url}" />
<param name="plugin-icon">images/pluginIcon.png</param>
<param name="plugin-logo">images/pluginLogo.png</param>

<!-- add our i18n resource -->
<resource type="i18n" name="i18n" location="AnneJiraPlugin"/>

<!-- add our web resources -->
<web-resource key="AnneJiraPlugin-resources" name="AnneJiraPlugin Web Resources">

<resource type="download" name="AnneJiraPlugin.css" location="/css/AnneJiraPlugin.css"/>
<resource type="download" name="AnneJiraPlugin.js" location="/js/AnneJiraPlugin.js"/>
<resource type="download" name="images/" location="/images"/>


<rest name="My Rest Resource" key="my-rest-resource" path="/anne" version="1.0">
<description>The My Rest Resource Plugin</description>



Suggest an answer

Log in or Sign up to answer
Community showcase
Published Jan 08, 2019 in Jira

How to Jira for designers

I’m a designer on the Jira team. For a long time, I’ve fielded questions from other designers about how they should be using Jira Software with their design team. I’ve also heard feedback from other ...

1,232 views 5 10
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you