|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.plugins.restapi.resources.ContentLabelsResource
public class ContentLabelsResource
REST wrapper for the ContentLabelService
.
Constructor Summary | |
---|---|
ContentLabelsResource(ContentLabelService contentLabelService)
|
Method Summary | |
---|---|
PageResponse<Label> |
addLabels(ContentId contentId,
List<Label> labels)
Adds a list of labels to the specified content. |
PageResponse<Label> |
labels(ContentId contentId,
List<String> prefixes,
int start,
int limit,
javax.ws.rs.core.UriInfo uriInfo)
Returns the list of labels on a piece of Content. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContentLabelsResource(ContentLabelService contentLabelService)
Method Detail |
---|
@PublicApi public PageResponse<Label> labels(ContentId contentId, List<String> prefixes, int start, int limit, @Context javax.ws.rs.core.UriInfo uriInfo) throws ServiceException
Returns the list of labels on a piece of Content.
Example request URI(s):
http://example.com/rest/api/content/1234/label
http://example.com/rest/api/content/1234/label?prefix=global&start=0&limit=200
contentId
- a string containing the id of the labels content containerprefixes
- the prefixes to filter the labels with Label.Prefix
start
- the start point of the collection to returnlimit
- the limit of the number of labels to return, this may be restricted by fixed system limitsuriInfo
- (injected) information about the request URI
ServiceException
@PublicApi public PageResponse<Label> addLabels(ContentId contentId, List<Label> labels) throws ServiceException
Adds a list of labels to the specified content.
The body is the json representation of the list.
Example body:
[ { "prefix": "global", "name": "label2" },
{ "prefix": "global", "name": "label2" } ]
contentId
- A string containing the id of the labels content containerlabels
- list of labels to add
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |