YouTrack Standalone 2019.2 Help

Operations with Specific IssueComment

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. 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 Specific IssueComment

Read a comment with a specific ID.

Request syntax

GET /api/issues/{issueID}/comments/{commentID}?{fields}

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

Update a Specific IssueComment

Update an existing comment of the specific issue.

Request syntax

POST /api/issues/{issueID}/comments/{commentID}?{fields}

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issues/2-31/comments/4-2/?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": "okay, let'\''s do it, @jane.doe. By the way, I'\''m updating this comment using REST.", "visibility": { "permittedGroups":[{"id":"3-2"}], "$type": "LimitedVisibility" } }

Sample response body

{ "deleted": false, "author": { "login": "john.doe", "name": "John Doe", "id": "1-2" }, "visibility": { "permittedUsers": [], "permittedGroups": [ { "name": "Sample Project Team", "id": "3-2" } ], "$type": "LimitedVisibility" }, "text": "okay, let's do it, @jane.doe. By the way, I'm updating this comment using REST.", "updated": 1535542466727, "id": "4-2" }

Delete a Specific IssueComment

Delete an existing comment of the specific issue.

Request syntax

DELETE /api/issues/{issueID}/comments/{commentID}

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issues/2-7/comments/4-5
Last modified: 13 August 2019