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

Question

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) { try { // 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(); builder.where().project(project.getName()); 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 permissions = new HashSet<>(); permissions.add(permission); SharePermissions sharePermissions = new SharePermissions(permissions); searchRequest.setPermissions(sharePermissions); // set the owner of the filter searchRequest.setOwner(user); // 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 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.

Anne Calantog · Answer

Hi, 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: 4.0.0 com.anne AnneJiraPlugin 1.0.0-SNAPSHOT Example Company http://www.example.com/ AnneJiraPlugin This is the com.anne:AnneJiraPlugin plugin for Atlassian JIRA. atlassian-plugin com.atlassian.jira jira-api ${jira.version} provided junit junit 4.10 test com.atlassian.plugin atlassian-spring-scanner-annotation ${atlassian.spring.scanner.version} compile com.atlassian.plugin atlassian-spring-scanner-runtime ${atlassian.spring.scanner.version} runtime javax.inject javax.inject 1 provided com.atlassian.plugins atlassian-plugins-osgi-testrunner ${plugin.testrunner.version} test javax.ws.rs jsr311-api 1.1.1 provided com.google.code.gson gson 2.2.2-atlassian-1 com.atlassian.jira.plugins jira-greenhopper-plugin 6.7.7 provided javax.ws.rs jsr311-api 1.1.1 provided com.atlassian.maven.plugins maven-jira-plugin ${amps.version} true ${jira.version} ${jira.version} true false

${atlassian.plugin.key}

com.anne.api,

org.springframework.osgi.*;resolution:="optional", org.eclipse.gemini.blueprint.*;resolution:="optional", com.atlassian.jira.plugins.*, com.atlassian.greenhopper.*, *

*

com.atlassian.plugin atlassian-spring-scanner-maven-plugin ${atlassian.spring.scanner.version} atlassian-spring-scanner process-classes com.atlassian.plugin atlassian-spring-scanner-external-jar false 7.5.0 6.3.6 1.2.3 1.2.13 ${project.groupId}.${project.artifactId} 6.3.11 UTF-8 2. I tested my retrieval by creating a private REST endpoint, this is what my board retrieval looks like: package com.anne.rest; 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.security.JiraAuthenticationContext; import com.atlassian.jira.user.ApplicationUser; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; @Path("/board-anne") public class BoardRest{ private JiraAuthenticationContext jiraAuthenticationContext = ComponentAccessor.getJiraAuthenticationContext(); private RapidViewService rapidViewService = (RapidViewService) ComponentAccessor.getOSGiComponentInstanceOfType(RapidViewService.class); @GET @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public Response getBoard() { ApplicationUser user = jiraAuthenticationContext.getLoggedInUser(); ServiceOutcome rapidView = rapidViewService.getRapidView(user, Long.valueOf(1)); System.out.print(rapidView.getValue().getName()); return Response.ok(rapidView.getValue().getName()).build(); } } ``` - This should return the Kanban Name (see screenshot) 3. atlassian-plugin.xml looks like this:

${project.description} ${project.version} images/pluginIcon.png images/pluginLogo.png

com.atlassian.auiplugin:ajs AnneJiraPlugin

The My Rest Resource Plugin

Kirk Walek · Answer

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: https://marketplace.atlassian.com/plugins/org.swift.jira.cli/cloud/overview

Michael Metivier · 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.