Class Experimental

Adds labels to a piece of content. Does not modify the existing labels.

Notes:

• Labels can also be added when creating content (Create content).
• Labels can be updated when updating content (Update content). This will delete the existing labels and replace them with the labels in the request.

Permissions required: Permission to update the content.

Adds labels to a piece of content. Does not modify the existing labels.

Notes:

• Labels can also be added when creating content (Create content).
• Labels can be updated when updating content (Update content). This will delete the existing labels and replace them with the labels in the request.

Permissions required: Permission to update the content.

Creates a property for a user. For more information about user properties, see [Confluence entity properties] (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level.

Note: the number of properties which could be created per app in a tenant for each user might be restricted by fixed system limits. Permissions required: Permission to access the Confluence site ('Can use' global permission).

Creates a property for a user. For more information about user properties, see [Confluence entity properties] (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). Note, these properties stored against a user are on a Confluence site level and not space/content level.

Note: the number of properties which could be created per app in a tenant for each user might be restricted by fixed system limits. Permissions required: Permission to access the Confluence site ('Can use' global permission).

Moves a pagetree rooted at a page to the space's trash:

• If the content's type is page and its status is current, it will be trashed including all its descendants.
• For every other combination of content type and status, this API is not supported.

This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.

Use the /longtask/<taskId> REST API to get the copy task status.

Permissions required: 'Delete' permission for the space that the content is in.

Moves a pagetree rooted at a page to the space's trash:

• If the content's type is page and its status is current, it will be trashed including all its descendants.
• For every other combination of content type and status, this API is not supported.

This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.

Use the /longtask/<taskId> REST API to get the copy task status.

Permissions required: 'Delete' permission for the space that the content is in.

Deletes a property for the given user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Deletes a property for the given user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.

Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.

Returns the properties for a user as list of property keys. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Returns the properties for a user as list of property keys. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Returns the property corresponding to key for a user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Returns the property corresponding to key for a user. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Deprecated

Get the total number of distinct viewers a piece of content has.

Deprecated

Get the total number of distinct viewers a piece of content has.

Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).