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

Class ContentRestrictionResource

java.lang.Object

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

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)	Returns info about all restrictions by operation
ContentRestriction	forOperation(ContentId id, OperationKey opKey, String expand, int start, int limit)	Returns info about all restrictions of given operation

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentRestrictionResource

public ContentRestrictionResource(ContentRestrictionService service)

Method Detail

byOperation

@PublicApi
public Map<OperationKey,ContentRestriction> byOperation(ContentId id,
                                                              String expand)

Returns info about all restrictions by operation

Parameters:

id - the id of the content

expand - a comma separated list of properties to expand on the content properties. Default value: group.

Returns:

a JSON representation of the restrictions group by operations

forOperation

@PublicApi
public ContentRestriction forOperation(ContentId id,
                                       OperationKey opKey,
                                       String expand,
                                       int start,
                                       int limit)

Returns info about all restrictions of given operation

Parameters:

id - the id of the content

opKey - key of the operation

expand - a comma separated list of properties to expand on the content properties. Default value: group.

start - pagination start

limit - pagination limit

Returns:

a JSON representation of the restrictions group by operations