Issue Comments
This resource lets you work with comments of an issue.
Resource | |
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 List of IssueComments
Get all accessible comments of the specific issue.
Request syntax
GET /api/issues/{issueID}/comments?{fields}&{$top}&{$skip}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 |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issues/2-31/comments?fields=id,author%28login,name,id%29,deleted,text,updated,visibility%28permittedGroups%28name,id%29,permittedUsers%28id,name,login%29%29Sample response body
[
{
"author": {
"login": "jane.doe",
"name": "Jane Doe",
"id": "1-3"
},
"deleted": false,
"updated": null,
"text": "@john.doe let's update the summary and description",
"visibility": {
"permittedGroups": [
{
"name": "Sample Project Team",
"id": "3-2"
}
],
"permittedUsers": [],
"$type": "LimitedVisibility"
},
"id": "4-0"
},
{
"author": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2"
},
"deleted": false,
"updated": 1533223079255,
"text": "okay, let's do it, @jane.doe. I am btw updating this from rest",
"visibility": {
"$type": "UnlimitedVisibility"
},
"id": "4-2"
}
]Add a New IssueComment
Add a new comment to an issue with a specific ID.
Required permissions
Requires Create Comment permission.
Request syntax
POST /api/issues/{issueID}/comments?{fields}&{draftId}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 |
draftId | String | ID of an existing draft that should be published. This parameter is optional. |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issues/2-6/comments?fields=id,author%28login,name,id%29,deleted,text,updated,visibility%28permittedGroups%28name,id%29,permittedUsers%28id,name,login%29%29Sample request body
{
"text": "Disregard the previous comment. The problem still requires investigation.",
"visibility": {
"permittedGroups": [
{
"id": "3-2"
}
],
"$type": "LimitedVisibility"
}
}Sample response body
{
"author": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"deleted": false,
"text": "Disregard the previous comment. The problem still requires investigation.",
"visibility": {
"permittedUsers": [],
"permittedGroups": [
{
"name": "Sample Project Team",
"id": "3-2",
"$type": "UserGroup"
}
],
"$type": "LimitedVisibility"
},
"updated": null,
"id": "4-14",
"$type": "IssueComment"
}