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

Class GroupAndUserPickerResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.GroupAndUserPickerResource

@Path("groupuserpicker")
@Consumes("application/json")
@Produces("application/json")
public class GroupAndUserPickerResource
extends Object

Constructor Summary

Constructors

Constructor

Description

GroupAndUserPickerResource(JiraAuthenticationContext authContext, ConstantsManager constantsManager, CustomFieldManager customFieldManager, FieldConfigSchemeManager fieldConfigSchemeManager, GroupPickerResourceHelper groupPickerHelper, PermissionManager permissionManager, ProjectManager projectManager, UserFilterManager userFilterManager, UserPickerResourceHelper userPickerHelper, GlobalPermissionManager globalPermissionManager, I18nHelper i18n)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	findUsersAndGroups(String query, Integer maxResults, Boolean showAvatar, String fieldId, List<String> projectId, List<String> issueTypeId)	Returns a list of users and groups matching query with highlighting.

Methods inherited from class java.lang.Object

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

Constructor Details

GroupAndUserPickerResource

@Inject
public GroupAndUserPickerResource(JiraAuthenticationContext authContext,
 ConstantsManager constantsManager,
 CustomFieldManager customFieldManager,
 FieldConfigSchemeManager fieldConfigSchemeManager,
 GroupPickerResourceHelper groupPickerHelper,
 PermissionManager permissionManager,
 ProjectManager projectManager,
 UserFilterManager userFilterManager,
 UserPickerResourceHelper userPickerHelper,
 GlobalPermissionManager globalPermissionManager,
 I18nHelper i18n)

Method Details

findUsersAndGroups

@GET
public jakarta.ws.rs.core.Response findUsersAndGroups(@QueryParam("query")
 String query,
 @QueryParam("maxResults")
 Integer maxResults,
 @QueryParam("showAvatar")
 Boolean showAvatar,
 @QueryParam("fieldId")
 String fieldId,
 @QueryParam("projectId")
 List<String> projectId,
 @QueryParam("issueTypeId")
 List<String> issueTypeId)

Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.

Parameters:

query - A string used to search username, Name or e-mail address

maxResults - The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated if you send a request with startAt=98 and maxResults=20, it will only return 2 users.

showAvatar -

fieldId - The custom field id, if this request comes from a custom field, such as a user picker. Optional.

projectId - The list of project ids to further restrict the search This parameter can occur multiple times to pass in multiple project ids. Comma separated value is not supported. This parameter is only used when fieldId is present.

issueTypeId - The list of issue type ids to further restrict the search. This parameter can occur multiple times to pass in multiple issue type ids. Comma separated value is not supported. Special values such as -1 (all standard issue types), -2 (all subtask issue types) are supported. This parameter is only used when fieldId is present.

Returns:

An object containing list of matched user objects, with html representing highlighting.