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.


1 answer

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:

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

3,327 views 14 20
Join discussion

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
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot