{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Content Comments API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Content Comments", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Content Comments", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/comment", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its comments." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment." }, { "name": "parentVersion", "value": "", "type": "query", "description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned comments." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of comments to return per page. Note,\nthis may be restricted by fixed system limits." }, { "name": "location", "value": "", "type": "query", "description": "The location of the comments in the page. Multiple locations can be specified.\nIf no location is specified, comments from all locations are returned." }, { "name": "depth", "value": "", "type": "query", "description": "Currently, this parameter is not used.\nComments are returned at the root level only." } ] }, "docs": "Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).

Returns the comments on a piece of content.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space,
and permission to view the content if it is a page." } ] } ], "bundled": true }