v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Content restrictions

Get restrictions

Returns the restrictions on a piece of content.

Permissions required: Permission to view the content.

get/wiki/rest/api/content/{id}/restriction

Path parameters

idstring required

The ID of the content to be queried for its restrictions.

Query parameters

expandstring[]

A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: restrictions.user, restrictions.group.

  • restrictions.user returns the piece of content that the restrictions are applied to.
  • restrictions.group returns the piece of content that the restrictions are applied to.
  • content returns the piece of content that the restrictions are applied to.
startinteger

The starting index of the users and groups in the returned restrictions.

limitinteger

The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

Response

Returned if the requested restrictions are returned.

startinteger required
limitinteger required
sizeinteger required
restrictionsHashstring required

This property is used by the UI to figure out whether a set of restrictions has changed.

_linksGenericLinks required