Operations with Specific IssueComment
This resource lets you work with comments of an issue.
Resource | /api/issues/{issueID}/comments/{commentID} |
Returned entity | IssueComment. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
IssueComment attributes
Represents an existing issue comment.
This table describes attributes of the IssueComment
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
text | String | The text of the comment. |
usesMarkdown | Boolean | When `true`, the comment text is parsed as Markdown. When `false`, the comment text is parsed as YouTrack Wiki. Changing this value does not transform the markup from one syntax to another. |
textPreview | String | The comment text as it is shown in UI after processing with wiki/markdown (including HTML markup). |
created | Long | Time the comment was created as a timestamp. |
updated | Long | Time the comment was last updated as a timestamp. |
author | User | The user who created the comment. |
issue | Issue | The issue the comment belongs to. |
attachments | Array of IssueAttachments | The list of attachments that are attached to the comment. |
visibility | Visibility | Visibility settings of the comment. They define who is allowed to see the comment. |
deleted | Boolean | When |
Read a Specific IssueComment
Read a comment with a specific ID.
Required permissions
Requires read access to the issue. If user is the author of the comment, comment is always visible. Otherwise
Request syntax
{commentID} | Database ID of the comment. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueComment attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Sample response body
Update a Specific IssueComment
Update an existing comment of the specific issue.
Required permissions
Requires Update Comment permission for own comments and Update Not Own Comment permission for not own comments.
Request syntax
{commentID} | Database ID of the comment. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueComment attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Sample request body
Sample response body
Delete a Specific IssueComment
Delete an existing comment of the specific issue.
Required permissions
Requires Delete Comment permission for own comments and Delete Not Own Comment permission for not own comments.
Request syntax
{commentID} | Database ID of the comment. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueComment attributes that should be returned in the response. If no field is specified,only the |