Comments
Returns information about comments made on pages, blog posts, or other content, including author details and timestamps.
Table Specific Information
Select
The add-in uses the Confluence API to process WHERE clause conditions built with the following columns and operators. Conditions that use other supported operators are processed client-side by the add-in. You can also search for Attachments using CQL (Confluence Query Language).
- Id supports the '=,!=,IN,NOT IN' comparisons.
- Type supports the '=,!=,IN,NOT IN' comparisons.
- Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
Note: Only LIKE and NOT LIKE comparisons on Title are processed server-side, while all other operators (=,!=,IN,NOT IN) are processed on the client-side. - SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
- SpaceType supports the '=,!=,IN,NOT IN' comparisons.
- CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
- CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
- LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Comments WHERE Id = '1234'
SELECT * FROM Comments WHERE Id IN ('1234', '2345')
SELECT * FROM Comments WHERE Id = '294922' OR Type = 'comment'
SELECT * FROM Comments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Comments ORDER BY Id DESC SELECT * FROM Comments ORDER BY CreatedByUserName ASC
CQL
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Comments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
Columns
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the comment within Confluence. Used to reference the comment in related tables or operations. | |
| Type | String | =,!=,IN,NOT_IN | Specifies the content type, indicating that this record represents a comment. | |
| Title | String | The title or short reference for the comment, which may appear as the first line of text or a system-generated identifier. | ||
| Status | String | Indicates the current state of the comment, such as active, deleted, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space that contains the content to which the comment belongs. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space where the comment was made, such as global, personal, or team space. |
| Position | String | Defines the comment's position within the discussion thread or its relationship to the parent content. | ||
| URL | String | The full URL that provides direct access to the comment within the Confluence interface or API. | ||
| Excerpt | String | A short snippet of the comment's text content, used for previews or summaries. | ||
| IsLatest | Boolean | If the value is 'true', this comment represents the latest version of the text. If the value is 'false', it refers to an earlier revision. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally posted the comment. | |
| CreatedByUserType | String | Specifies the type of user who created the comment, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the comment was first posted. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the comment was most recently edited. | |
| LastUpdatedMessage | String | The revision note or message entered by the user when updating the comment. | ||
| LastUpdatedNumber | Integer | The version number corresponding to the latest update of the comment. | ||
| LastUpdatedUserName | String | The username of the user who performed the most recent update on the comment. | ||
| LastUpdatedUserType | String | Indicates the type of user who made the latest update, such as internal, external, or automated. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the last modification was a minor edit that did not significantly change the content. If the value is 'false', it was a major edit. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the comment is hidden from regular users. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who created or edited the previous version of the comment. | ||
| PreviousVersionUserType | String | Specifies the type of user who updated the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the comment was modified. | ||
| PreviousVersionMessage | String | The user's revision note or message associated with the previous version of the comment. | ||
| PreviousVersionNumber | String | The version number assigned to the previous iteration of the comment. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the comment is hidden from visibility. If the value is 'false', it remains visible. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the comment, allowing users to modify or reply within the Confluence editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the comment, used for programmatic retrieval. | ||
| LinksTinyui | String | The short link (TinyUI) URL of the comment, providing a concise version for quick sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the comment as viewed within Confluence. | ||
| ItemURL | String | The complete URL reference to the comment as displayed in the user interface. | ||
| ContainerId | String | The unique identifier of the container, such as the page or blog post, that the comment belongs to. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering comments. |