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

Class LabelResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.LabelResource

@Consumes("application/json")
@Produces("application/json")
@Path("/label")
public class LabelResource
extends Object

REST wrapper for the LabelService.

Constructor Summary

Constructors

Constructor	Description
LabelResource(LabelService labelService)

Method Summary

Modifier and Type	Method	Description
RestList<Label>	labels(String labelName, String owner, String namespace, String spaceKey, int start, int limit, javax.ws.rs.core.UriInfo uriInfo)
PageResponse<Label>	popular(int start, int limit, javax.ws.rs.core.UriInfo uriInfo)
PageResponse<Label>	recent(int start, int limit, javax.ws.rs.core.UriInfo uriInfo)
PageResponse<Label>	related(javax.ws.rs.core.UriInfo uriInfo, String labelName, int start, int limit)

Methods inherited from class java.lang.Object

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

Constructor Details

LabelResource

@Inject
public LabelResource(LabelService labelService)

Method Details

labels

@GET
@Path("labels")
public RestList<Label> labels(@QueryParam("labelName")
 String labelName,
 @QueryParam("owner")
 String owner,
 @QueryParam("namespace")
 String namespace,
 @QueryParam("spaceKey")
 String spaceKey,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                       throws ServiceException

Throws:

ServiceException

related

@GET
@Path("/{labelName}/related")
public PageResponse<Label> related(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("labelName")
 String labelName,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit)
                            throws ServiceException

Throws:

ServiceException

recent

@GET
@Path("/recent")
public PageResponse<Label> recent(@QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                           throws ServiceException

Throws:

ServiceException

popular

@GET
@Path("/popular")
public PageResponse<Label> popular(@QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                            throws ServiceException

Throws:

ServiceException