Comments
Manages comments added to issues. Supports creating, reading, updating, and deleting issue comments.
Table-Specific Information
SELECT
You can query this table to retrieve comments posted on all issues.The add-in uses the Jira API to process filters based on the IssueId, IssueKey, ProjectId, and ProjectName columns. The add-in processes all other filters client-side.
For example, the following queries are processed server-side:
SELECT * FROM Comments WHERE IssueId = 10003;
SELECT * FROM Comments WHERE ProjectId = 10100;
SELECT * FROM Comments WHERE IssueId = 10003 ORDER BY Created DESC;
INSERT
Insert a comment by specifying the IssueId and Body columns.INSERT INTO Comments (IssueId, Body) VALUES ('10003', 'Test Comment');
UPDATE
Update a comment by specifying the Id, IssueId, and the columns to update.UPDATE Comments SET Body = 'Updated Comment' WHERE Id = 10202 AND IssueId = 10003;
ADF Fields (REST_V3)
When the APIVersion connection property is set to REST_V3, the Body_ADF column is available alongside Body. Use Body to insert or update a plain-text value, which the driver wraps into ADF format automatically. Use Body_ADF to supply raw ADF JSON directly.Insert a comment with a plain-text body (wrapped as ADF automatically):
INSERT INTO Comments (IssueId, Body) VALUES ('10003', 'Plain text comment');
Insert a comment with a raw ADF JSON body:
INSERT INTO Comments (IssueId, Body_ADF) VALUES ('10003', '{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"Raw ADF comment"}]}]}');
Update a comment body using plain text:
UPDATE Comments SET Body = 'Updated comment' WHERE Id = 10202 AND IssueId = 10003;
Update a comment body using raw ADF JSON:
UPDATE Comments SET Body_ADF = '{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"Updated ADF comment"}]}]}' WHERE Id = 10202 AND IssueId = 10003;
NOTE: Specifying both Body and Body_ADF in the same statement results in an error. Use one or the other.
DELETE
Delete a comment by specifying the Id and IssueId.DELETE FROM Comments WHERE Id = 10202 AND IssueId = 10003;
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Integer | True | = | Common |
The unique identifier assigned to the comment within the Jira system. | |
| IssueId [KEY] | Integer | False | Issues.Id | =,!=,IN,NOT IN | Common |
The numeric ID of the issue that the comment is associated with. This ID is internal to Jira. |
| IssueKey | String | False | Issues.Key | =,!=,IN,NOT IN | Common |
The issue key linked to the comment, such as 'PROJ-101', which uniquely identifies the issue in a human-readable format. |
| ProjectId | Integer | True | Projects.Id | =,IS,IS NOT,IN,NOT IN | Common |
The numeric ID of the project that contains the issue the comment belongs to. |
| ProjectName | String | True | =,IS,IS NOT,IN,NOT IN | Common |
The name of the project that includes the issue associated with this comment. | |
| IssueCreatedDate | Datetime | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date and time when the issue linked to this comment was originally created. | |
| IssueUpdatedDate | Datetime | True | =,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN | Common |
The date and time when the issue related to this comment was last updated. | |
| AuthorDisplayName | String | True | Users.DisplayName | Common |
The full display name of the user who originally created the comment. | |
| AuthorEmail | String | True | Users.EmailAddress | Common |
The email address associated with the user who created the comment. | |
| UpdateDisplayName | String | True | Users.DisplayName | Common |
The full display name of the user who last updated or edited the comment. | |
| UpdateAuthorEmail | String | True | Users.EmailAddress | Common |
The email address of the user who most recently modified the comment. | |
| Body | String | False | =,LIKE | Common |
The raw content of the comment, typically in plain text or markup, as entered by the author. | |
| Body_ADF | String | False | Cloud |
Raw Atlassian Document Format (ADF) JSON value of 'Body'. Available only when the APIVersion connection property is set to REST_V3. | ||
| Created | Datetime | True | Common |
The timestamp indicating when the comment was first submitted. | ||
| Updated | Datetime | True | Common |
The timestamp indicating the most recent update to the comment, if applicable. | ||
| VisibilityType | String | False | Common |
The method used to restrict comment visibility, such as by group or project role. | ||
| VisibilityValue | String | False | Common |
The specific group name or role name used to control who can view the comment. | ||
| AuthorAccountName | String | True | Server |
The username of the Jira account that created the comment. | ||
| AuthorAccountKey | String | True | Server |
The unique Jira user key corresponding to the account that authored the comment. | ||
| UpdateAuthorAccountKey | String | True | Server |
The unique Jira user key of the account that last modified the comment. | ||
| UpdateAuthorAccountName | String | True | Server |
The username of the user who most recently edited the comment. | ||
| AuthorAccountId | String | True | Users.AccountId | Cloud |
The Jira account ID of the user who originally posted the comment. This ID is used in API interactions. | |
| UpdateAuthorAccountId | String | True | Users.AccountId | Cloud |
The Jira account ID of the user who most recently updated the comment. This is used for audit tracking. | |
| ItemURL | String | True | Common |
A URL pointing directly to the comment, allowing users to open it in the Jira interface. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| JQL | String |
A Jira Query Language (JQL) expression used to retrieve issues with specific comment criteria, such as author or date range. |