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

Class ContentRestrictionResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.ContentRestrictionResource

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

Constructor Summary

Constructors

Constructor	Description
ContentRestrictionResource(ContentRestrictionService service)

Method Summary

Modifier and Type	Method	Description
Map<OperationKey,ContentRestriction>	byOperation(ContentId id, String expand)
ContentRestriction	forOperation(ContentId id, OperationKey opKey, String expand, int start, int limit)
RelevantViewRestrictions	relevantViewRestrictions(ContentId id, String expand, int start, int limit)
PageResponse<ContentRestriction>	updateRestrictions(ContentId contentId, String expand, List<ContentRestriction> contentRestrictions)

Methods inherited from class java.lang.Object

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

Constructor Details

ContentRestrictionResource

@Inject
public ContentRestrictionResource(ContentRestrictionService service)

Method Details

relevantViewRestrictions

@PublicApi
@GET
@Path("relevantViewRestrictions")
public RelevantViewRestrictions relevantViewRestrictions(@PathParam("id")
 ContentId id,
 @QueryParam("expand") @DefaultValue("relevantViewRestrictions")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("50")
 int limit)

byOperation

@PublicApi
@GET
@Path("byOperation")
public Map<OperationKey,ContentRestriction> byOperation(@PathParam("id")
 ContentId id,
 @QueryParam("expand") @DefaultValue("update.restrictions.user,read.restrictions.group,read.restrictions.user,update.restrictions.group")
 String expand)

forOperation

@PublicApi
@GET
@Path("byOperation/{operationKey}")
public ContentRestriction forOperation(@PathParam("id")
 ContentId id,
 @PathParam("operationKey")
 OperationKey opKey,
 @QueryParam("expand") @DefaultValue("restrictions.user,restrictions.group")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit)

updateRestrictions

@PublicApi
@PUT
public PageResponse<ContentRestriction> updateRestrictions(@PathParam("id")
 ContentId contentId,
 @QueryParam("expand") @DefaultValue("restrictions.user,restrictions.group")
 String expand,
 List<ContentRestriction> contentRestrictions)