Comments
Retrieves user comments posted on app records, allowing teams to analyze collaboration activity or export conversation history to external reporting tools.
Select
The RecordId and AppId columns are required in the WHERE clause. The cmdlet will use the Kintone APIs to filter the results by these columns. The Kintone APIs also support filters on Id. By default, the cmdlet will process other filters client-side within the cmdlet.
For example, the following queries are processed server side:
SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1
Insert
The AppId and RecordId columns are required in the INSERT statement.
INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')
Delete
Comments can be deleted by issuing a DELETE statement and specifying the RecordId, AppId, and Id.
DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Identifier of the comment, used to uniquely reference the comment within the app and link it to related actions or metadata. | |
| AppId [KEY] | Integer | False |
Identifier of the app that contains the record on which the comment was posted, helping associate discussions with a specific application. | |
| RecordId [KEY] | Integer | False |
Identifier of the record that the comment belongs to, allowing you to trace conversations tied to individual data entries. | |
| Text | Longvarchar | False |
Full text of the comment, including any line feed characters used to preserve formatting or multi-line input. | |
| CreatorCode | String | True |
Login name of the user who created the comment, supporting auditing and user activity tracking. | |
| CreatorName | String | True |
Display name of the user who created the comment, used to present readable author information in interfaces or reports. | |
| CreatedAt | Datetime | True |
Date and time when the comment was created, providing a chronological reference for discussions and activity history. | |
| MentionsAggregate | String | False |
Array containing details about the users mentioned in the comment, enabling notifications and tracking of directed communication. |