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

Class SpacePropertyResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.SpacePropertyResource

@PublicApi
@Consumes("application/json")
@Produces("application/json")
@Path("/space/{spaceKey}/property")
public class SpacePropertyResource
extends Object

A REST resource for manipulating space properties.

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

Since:

5.9

Constructor Summary

Constructors

Constructor	Description
SpacePropertyResource(SpacePropertyService service)

Method Summary

Modifier and Type	Method	Description
JsonSpaceProperty	create(String spaceKey, JsonSpaceProperty newProperty)
JsonSpaceProperty	create(String spaceKey, String propertyKey, JsonSpaceProperty newProperty)
javax.ws.rs.core.Response	delete(String spaceKey, String propertyKey)
PageResponse<JsonSpaceProperty>	get(String spaceKey, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo)
JsonSpaceProperty	get(String spaceKey, String propertyKey, String expand)
JsonSpaceProperty	update(String spaceKey, String propertyKey, JsonSpaceProperty property)

Methods inherited from class java.lang.Object

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

Constructor Details

SpacePropertyResource

@Inject
public SpacePropertyResource(SpacePropertyService service)

Method Details

create

@POST
public JsonSpaceProperty create(@PathParam("spaceKey")
 String spaceKey,
 JsonSpaceProperty newProperty)
                         throws ServiceException

Throws:

ServiceException

create

@POST
@Path("{key}")
public JsonSpaceProperty create(@PathParam("spaceKey")
 String spaceKey,
 @PathParam("key")
 String propertyKey,
 JsonSpaceProperty newProperty)
                         throws ServiceException

Throws:

ServiceException

get

@GET
public PageResponse<JsonSpaceProperty> get(@PathParam("spaceKey")
 String spaceKey,
 @QueryParam("expand") @DefaultValue("version")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("10")
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                    throws ServiceException

Throws:

ServiceException

get

@GET
@Path("{key}")
public JsonSpaceProperty get(@PathParam("spaceKey")
 String spaceKey,
 @PathParam("key")
 String propertyKey,
 @QueryParam("expand") @DefaultValue("version")
 String expand)
                      throws ServiceException

Throws:

ServiceException

update

@PUT
@Path("{key}")
public JsonSpaceProperty update(@PathParam("spaceKey")
 String spaceKey,
 @PathParam("key")
 String propertyKey,
 JsonSpaceProperty property)
                         throws ServiceException

Throws:

ServiceException

delete

@DELETE
@Path("{key}")
public javax.ws.rs.core.Response delete(@PathParam("spaceKey")
 String spaceKey,
 @PathParam("key")
 String propertyKey)
                                 throws ServiceException

Throws:

ServiceException