Issue Comments

This resource lets you work with comments of an issue.

Resource	/api/issues/{issueID}/comments
Returned entity	IssueComment. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of IssueComments. `POST`: Add a New IssueComment.

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. `Can be null`.
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). `Read-only`.
created	Long	Time the comment was created as a timestamp. `Read-only`. `Can be null`.
updated	Long	Time the comment was last updated as a timestamp. `Read-only`. `Can be null`.
author	User	The user who created the comment. `Read-only`. `Can be null`.
issue	Issue	The issue the comment belongs to. `Read-only`. `Can be null`.
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. `Can be null`.
deleted	Boolean	When `true`, the comment is considered to be deleted, otherwise false.

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 `entityID` is returned
$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%29
            

Sample 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 `entityID` is returned
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%29
            

Sample 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"
}
            

Last modified: 28 October 2020