Package com.atlassian.jira.rest.v2.issue.project

Class ProjectPickerResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.project.ProjectPickerResource

@Path("projects/picker")
@Consumes("application/json")
@Produces("application/json")
public class ProjectPickerResource
extends Object

Since:

8.21

Constructor Summary

Constructors

Constructor	Description
ProjectPickerResource(ProjectPicker projectPicker, JiraAuthenticationContext authenticationContext)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	searchForProjects(String query, int maxResults, boolean allowEmptyQuery)	Returns a list of projects visible to the user where project name and/or key is matching the given query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProjectPickerResource

@Autowired
@Inject
public ProjectPickerResource(ProjectPicker projectPicker,
 JiraAuthenticationContext authenticationContext)

Method Details

searchForProjects

@GET
public javax.ws.rs.core.Response searchForProjects(@QueryParam("query") @DefaultValue("")
 String query,
 @QueryParam("maxResults") @DefaultValue("0")
 int maxResults,
 @QueryParam("allowEmptyQuery") @DefaultValue("false")
 boolean allowEmptyQuery)

Returns a list of projects visible to the user where project name and/or key is matching the given query.

Parameters:

query - a sequence of characters expected to be found in the word-prefix of project name and/or key.

maxResults - maximum number of matches to return. Zero means a default limit of 100 and negative numbers return no results.

allowEmptyQuery - if true, and the query is empty, the method will return first results limited to the value of "maxResults" or default limit of 100.

Returns:

A list of projects matching the query.