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

Class ContentPropertyResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.ContentPropertyResource

@PublicApi
@Consumes("application/json")
@Produces("application/json")
@Path("/content/{id}/property")
public class ContentPropertyResource
extends Object

A REST resource for manipulating content properties.

Content properties are a key / value store of properties attached to a piece of Content. The key is a string, and the value is a JSON object.

Since:

5.6

Constructor Summary

Constructors

Constructor	Description
ContentPropertyResource(ContentPropertyService service)

Method Summary

Modifier and Type	Method	Description
JsonContentProperty	create(ContentId contentId, JsonContentProperty newProperty)
JsonContentProperty	create(ContentId contentId, String key, JsonContentProperty newProperty)
jakarta.ws.rs.core.Response	delete(ContentId contentId, String key)
RestList<JsonContentProperty>	findAll(ContentId contentId, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
JsonContentProperty	findByKey(ContentId contentId, String key, String expand)
JsonContentProperty	update(ContentId contentId, String key, JsonContentProperty property)

Methods inherited from class java.lang.Object

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

Constructor Details

ContentPropertyResource

@Inject
public ContentPropertyResource(ContentPropertyService service)

Method Details

create

@POST
public JsonContentProperty create(@PathParam("id")
 ContentId contentId,
 JsonContentProperty newProperty)
                           throws ServiceException

Throws:

ServiceException

create

@POST
@Path("{key}")
public JsonContentProperty create(@PathParam("id")
 ContentId contentId,
 @PathParam("key")
 String key,
 JsonContentProperty newProperty)
                           throws ServiceException

Throws:

ServiceException

findAll

@GET
public RestList<JsonContentProperty> findAll(@PathParam("id")
 ContentId contentId,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("10")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                      throws ServiceException

Throws:

ServiceException

findByKey

@GET
@Path("{key}")
public JsonContentProperty findByKey(@PathParam("id")
 ContentId contentId,
 @PathParam("key")
 String key,
 @QueryParam("expand")
 String expand)
                              throws ServiceException

Throws:

ServiceException

update

@PUT
@Path("{key}")
public JsonContentProperty update(@PathParam("id")
 ContentId contentId,
 @PathParam("key")
 String key,
 JsonContentProperty property)
                           throws IOException,
ServiceException

Throws:

IOException

ServiceException

delete

@DELETE
@Path("{key}")
public jakarta.ws.rs.core.Response delete(@PathParam("id")
 ContentId contentId,
 @PathParam("key")
 String key)
                                   throws ServiceException

Throws:

ServiceException