Package com.atlassian.confluence.plugins.restapi.resources

Class SearchResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.SearchResource

@PublicApi
@Consumes("application/json")
@Produces("application/json")
@Path("/search")
public class SearchResource
extends Object

API REST Resource for searching for entities in Confluence. Generally delegates to the CQLSearchService.

Constructor Summary

Constructors

Constructor	Description
SearchResource(CQLSearchService searchService, ObjectMapperProvider objectMapperProvider)

Method Summary

Modifier and Type	Method	Description
SearchPageResponse<SearchResult>	search(String cql, String cqlcontext, String excerpt, String expand, int offset, String afterOffset, int limit, boolean includeArchivedSpaces, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResource

@Inject
public SearchResource(CQLSearchService searchService,
 ObjectMapperProvider objectMapperProvider)

Method Details

search

@GET
public SearchPageResponse<SearchResult> search(@QueryParam("cql")
 String cql,
 @QueryParam("cqlcontext")
 String cqlcontext,
 @QueryParam("excerpt") @DefaultValue("highlight")
 String excerpt,
 @QueryParam("expand")
 String expand,
 @QueryParam("start") @DefaultValue("0")
 int offset,
 String afterOffset,
 @QueryParam("limit") @DefaultValue("25")
 int limit,
 @QueryParam("includeArchivedSpaces") @DefaultValue("false")
 boolean includeArchivedSpaces,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)