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

Class ContentLabelsResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.ContentLabelsResource

@Consumes("application/json")
@Produces("application/json")
@Path("/content/{id}/label")
public class ContentLabelsResource
extends Object

REST wrapper for the ContentLabelService.

Constructor Summary

Constructors

Constructor	Description
ContentLabelsResource(ContentLabelService contentLabelService, ObjectMapperProvider objectMapperProvider)

Method Summary

Modifier and Type	Method	Description
PageResponse<Label>	addLabels(ContentId contentId, String labels)
javax.ws.rs.core.Response	deleteLabel(ContentId contentId, String label)
javax.ws.rs.core.Response	deleteLabelWithQueryParam(ContentId contentId, String label)
PageResponse<Label>	labels(ContentId contentId, List<String> prefixes, int offset, int limit, 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

ContentLabelsResource

@Inject
public ContentLabelsResource(ContentLabelService contentLabelService,
 ObjectMapperProvider objectMapperProvider)

Method Details

labels

@PublicApi
@GET
public PageResponse<Label> labels(@PathParam("id")
 ContentId contentId,
 @QueryParam("prefix")
 List<String> prefixes,
 @QueryParam("start")
 int offset,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                           throws ServiceException

Throws:

ServiceException

addLabels

@PublicApi
@POST
public PageResponse<Label> addLabels(@PathParam("id")
 ContentId contentId,
 String labels)
                              throws ServiceException

Throws:

ServiceException

deleteLabel

@PublicApi
@DELETE
@Path("/{label}")
public javax.ws.rs.core.Response deleteLabel(@PathParam("id")
 ContentId contentId,
 @PathParam("label")
 String label)
                                      throws ServiceException

Throws:

ServiceException

deleteLabelWithQueryParam

@PublicApi
@DELETE
public javax.ws.rs.core.Response deleteLabelWithQueryParam(@PathParam("id")
 ContentId contentId,
 @QueryParam("name")
 String label)
                                                    throws ServiceException

Throws:

ServiceException