@Path(value="search") @Consumes(value={"application/xml","application/json"}) @Produces(value={"application/xml","application/json"}) @Singleton public class SearchResource extends Object
Constructor and Description |
---|
SearchResource(AdministrationConfigurationAccessor administrationConfigurationAccessor,
BambooUserManager bambooUserManager,
CachedPlanManager cachedPlanManager,
CustomVariableContext customVariableContext,
DeploymentVersionService deploymentVersionService,
GravatarService gravatarService,
ExtendedAuthorManager authorManager,
PlanRestService planRestService,
ProjectManager projectManager,
com.atlassian.sal.api.message.I18nResolver i18nResolver) |
Modifier and Type | Method and Description |
---|---|
SearchResultsList |
searchAuthors(String searchTerm,
boolean unlinkedOnly,
javax.ws.rs.core.UriInfo uriInfo)
A starts-with search of authors based on their authorname,
|
SearchResultsList |
searchBranches(String masterPlanKey,
boolean includeMasterBranch,
Integer releasedInDeployment,
String searchTerm,
javax.ws.rs.core.UriInfo uriInfo,
javax.ws.rs.core.HttpHeaders httpHeaders,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Performs a "starts with" search against full plan branch name and full plan branch key.
|
SearchResultsList |
searchJobs(String planKey,
String searchTerm,
javax.ws.rs.core.UriInfo uriInfo,
javax.ws.rs.core.HttpHeaders httpHeaders,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Performs a "starts with" search against full job name and full job key.
|
SearchResultsList |
searchPlans(String searchTerm,
javax.ws.rs.core.UriInfo uriInfo,
javax.ws.rs.core.HttpHeaders httpHeaders,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Performs a "starts with" search against full plan name and full plan key.
|
SearchResultsList |
searchProjects(String searchTerm,
javax.ws.rs.core.UriInfo uriInfo,
javax.ws.rs.core.HttpHeaders httpHeaders,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Performs a contains search against project name.
|
SearchResultsList |
searchStages(String planKey,
String stageId,
String searchTerm,
javax.ws.rs.core.UriInfo uriInfo,
javax.ws.rs.core.HttpHeaders httpHeaders,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Performs a "starts with" search against full job name and full job key.
|
SearchResultsList |
searchUsers(String searchTerm,
boolean includeAvatars,
javax.ws.rs.core.UriInfo uriInfo)
A starts-with search of users based on their username, full-name and if allowed email address.
|
SearchResultsList |
searchVersions(String searchTerm,
long deploymentProjectId,
String branchKey,
boolean chronologicalOrder,
javax.ws.rs.core.UriInfo uriInfo,
javax.ws.rs.core.HttpHeaders httpHeaders,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Performs a contains search against a version name.
|
public SearchResource(AdministrationConfigurationAccessor administrationConfigurationAccessor, BambooUserManager bambooUserManager, CachedPlanManager cachedPlanManager, CustomVariableContext customVariableContext, DeploymentVersionService deploymentVersionService, GravatarService gravatarService, ExtendedAuthorManager authorManager, PlanRestService planRestService, ProjectManager projectManager, com.atlassian.sal.api.message.I18nResolver i18nResolver)
@GET @Path(value="users") public SearchResultsList searchUsers(@QueryParam(value="searchTerm") String searchTerm, @QueryParam(value="includeAvatars") boolean includeAvatars, @Context javax.ws.rs.core.UriInfo uriInfo) throws Exception
searchTerm
- Mandatory. The term to search for in users.includeAvatars
- if true will include avatar urls in the response. If gravatar is not enabled, no urls will be returneduriInfo
- SearchResultsList
of UserSearchResult
Exception
@GET @Path(value="authors") public SearchResultsList searchAuthors(@QueryParam(value="searchTerm") String searchTerm, @QueryParam(value="unlinkedOnly") boolean unlinkedOnly, @Context javax.ws.rs.core.UriInfo uriInfo) throws Exception
searchTerm
- Mandatory. The term to search for in authors.unlinkedOnly
- if true will only include authors which are not currently linked to a user.uriInfo
- SearchResultsList
of AuthorSearchResult
Exception
@GET @Path(value="plans") public SearchResultsList searchPlans(@QueryParam(value="searchTerm") String searchTerm, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
searchTerm
- to search for. OptionaluriInfo
- httpHeaders
- authenticationContext
- SearchResultsList
of PlanSearchResult
@GET @Path(value="jobs/{planKey}") public SearchResultsList searchJobs(@PathParam(value="planKey") String planKey, @QueryParam(value="searchTerm") String searchTerm, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
planKey
- planKey for plan where jobs will be searched forsearchTerm
- to search for. OptionaluriInfo
- httpHeaders
- authenticationContext
- SearchResultsList
of PlanSearchResult
@GET @Path(value="stages/{planKey}") public SearchResultsList searchStages(@PathParam(value="planKey") String planKey, @QueryParam(value="stageId") String stageId, @QueryParam(value="searchTerm") String searchTerm, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
planKey
- planKey for plan where jobs will be searched forsearchTerm
- to search for. OptionaluriInfo
- httpHeaders
- authenticationContext
- SearchResultsList
of PlanSearchResult
@GET @Path(value="branches") public SearchResultsList searchBranches(@QueryParam(value="masterPlanKey") String masterPlanKey, @QueryParam(value="includeMasterBranch") boolean includeMasterBranch, @QueryParam(value="releasedInDeployment") Integer releasedInDeployment, @QueryParam(value="searchTerm") String searchTerm, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
searchTerm
- to search for. OptionalincludeMasterBranch
- should master branch be included into result. OptionalreleasedInDeployment
- id of deployment project - will return only branches that are released in this deployment. OptionaluriInfo
- httpHeaders
- authenticationContext
- SearchResultsList
of PlanSearchResult
@GET @Path(value="projects") public SearchResultsList searchProjects(@QueryParam(value="searchTerm") String searchTerm, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
searchTerm
- to search for. OptionaluriInfo
- httpHeaders
- authenticationContext
- SearchResultsList
of ProjectSearchResult
@GET @Path(value="versions") public SearchResultsList searchVersions(@QueryParam(value="searchTerm") String searchTerm, @QueryParam(value="deploymentProjectId") long deploymentProjectId, @QueryParam(value="branchKey") String branchKey, @QueryParam(value="chronologicalOrder") boolean chronologicalOrder, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.ws.rs.core.HttpHeaders httpHeaders, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
searchTerm
- to search for. OptionaldeploymentProjectId
- The deployment project to search under.branchKey
- narrow the search to releases created out of the branch. OptionaluriInfo
- httpHeaders
- authenticationContext
- SearchResultsList
of DeploymentVersionSearchResult
Copyright © 2016 Atlassian Software Systems Pty Ltd. All rights reserved.