Rate this page:
GET /wiki/rest/api/content/{id}/child/comment
Returns the comments on a piece of content.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Connect app scope required: READ
read:confluence-content.summary
read:content-details:confluence
string
The ID of the content to be queried for its comments.
Array<string>
A multi-value parameter indicating which properties of the content to expand.
childTypes.all
returns whether the content has attachments, comments, or child pages.
Use this if you only need to check whether the content has children of a particular type.childTypes.attachment
returns whether the content has attachments.childTypes.comment
returns whether the content has comments.childTypes.page
returns whether the content has child pages.container
returns the space that the content is in. This is the same as the information
returned by Get space.metadata.currentuser
returns information about the current user in relation to the content,
including when they last viewed it, modified it, contributed to it, or added it as a favorite.metadata.properties
returns content properties that have been set via the Confluence REST API.metadata.labels
returns the labels that have been added to the content.metadata.frontend
this property is only used by Atlassian.operations
returns the operations for the content, which are used when setting permissions.children.page
returns pages that are descendants at the level immediately below the content.children.attachment
returns all attachments for the content.children.comment
returns all comments on the content.restrictions.read.restrictions.user
returns the users that have permission to read the content.restrictions.read.restrictions.group
returns the groups that have permission to read the content. Note that
this may return deleted groups, because deleting a group doesn't remove associated restrictions.restrictions.update.restrictions.user
returns the users that have permission to update the content.restrictions.update.restrictions.group
returns the groups that have permission to update the content. Note that
this may return deleted groups because deleting a group doesn't remove associated restrictions.history
returns the history of the content, including the date it was created.history.lastUpdated
returns information about the most recent update of the content, including
who updated it and when it was updated.history.previousVersion
returns information about the update prior to the current content update.history.contributors
returns all of the users who have contributed to the content.history.nextVersion
returns information about the update after to the current content update.ancestors
returns the parent page, if the content is a page.body
returns the body of the content in different formats, including the editor format,
view format, and export format.body.storage
returns the body of content in storage format.body.view
returns the body of content in view format.version
returns information about the most recent update of the content, including who updated it
and when it was updated.descendants.page
returns pages that are descendants at any level below the content.descendants.attachment
returns all attachments for the content, same as children.attachment
.descendants.comment
returns all comments on the content, same as children.comment
.space
returns the space that the content is in. This is the same as the information returned by
Get space.In addition, the following comment-specific expansions can be used:
extensions.inlineProperties
returns inline comment-specific properties.extensions.resolution
returns the resolution status of each comment.form
integer
The version of the parent content to retrieve children for. Currently, this only works for the latest version.
0
, Minimum: 0
, Format: int32
integer
The starting index of the returned comments.
int32
integer
The maximum number of comments to return per page. Note, this may be restricted by fixed system limits.
25
, Minimum: 0
, Format: int32
Array<string>
The location of the comments in the page. Multiple locations can be specified. If no location is specified, comments from all locations are returned.
form
string
Currently, this parameter is not used. Comments are returned at the root level only.
1 2 3 4 5 6 7 8 9 10 11 12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/child/comment`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());
Returned if the requested comments are returned.
Content type | Value |
---|---|
application/json |
Rate this page: