public class

GroupPickerResource

extends Object
java.lang.Object
   ↳ com.atlassian.jira.rest.v2.issue.GroupPickerResource

Class Overview

REST endpoint for searching groups in a group picker

Summary

Public Constructors
GroupPickerResource(GroupPickerResourceHelper groupPickerHelper)
Public Methods
Response findGroups(String query, List<String> excludeGroups, Integer maxResults, String userName)
Returns groups with substrings matching a given query.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GroupPickerResource (GroupPickerResourceHelper groupPickerHelper)

Public Methods

public Response findGroups (String query, List<String> excludeGroups, Integer maxResults, String userName)

Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups.

The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit"

The groups will be unique and sorted.

Parameters
query a String to match groups agains
Returns
  • a collection of matching groups