Developer Portal for YouTrack and Hub 2021.3 Help

Article Comments

This resource lets you work with comments to an article.

Resource

/api/articles/{articleID}/comments

Returned entity

ArticleComment. For the description of the entity attributes, see Supported Fields section.

Supported methods

ArticleComment attributes

Represents a comment to an article.

This table describes attributes of the ArticleComment 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.

created

Long

The timestamp of the date and time when the comment was created. Read-only.

updated

Long

The timestamp of the date and time when the comment was last updated. Read-only.

author

User

The user who created the comment. Read-only. Can be null.

article

Article

The article the comment belongs to. Read-only. Can be null.

attachments

Array of ArticleAttachments

The list of attachments that are attached to the comment.

visibility

Visibility

The visibility settings of the comment. They define who is allowed to see the comment. Can be null.

Read a List of ArticleComments

Get all accessible comments to a specific article.

Request syntax

GET /api/articles/{articleID}/comments?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

String

A list of ArticleComment 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

https://example.myjetbrains.com/youtrack/api/articles/NP-A-7/comments?fields=id,author(id,name),text,created,visibility(permittedGroups(id,name),permittedUsers(id,name))

Sample response body

[ { "author": { "name": "John Smith", "id": "24-0", "$type": "User" }, "created": 1629984248559, "visibility": { "$type": "UnlimitedVisibility" }, "text": "Hello world!", "id": "251-0", "$type": "ArticleComment" } ]

Add a New ArticleComment

Add a new comment to an article with a specific ID.

Required permissions

Requires Create Comment permission.

Request syntax

POST /api/articles/{articleID}/comments?{fields}&{draftId}&{muteUpdateNotifications}

Request parameters

Parameter

Type

Description

fields

String

A list of ArticleComment attributes that should be returned in the response. If no field is specified,only the entityID is returned

draftId

String

The ID of an existing draft that should be published. This parameter is optional.

muteUpdateNotifications

Boolean

Set this parameter to true if no notifications should be sent on changes made by this request. This doesn't mute notifications sent by any workflow rules. Using this parameter requires Apply Commands Silently permission in all projects affected by the request. Available since 2021.3.

Sample

Sample request

https://example.myjetbrains.com/youtrack/api/articles/NP-A-7/comments?fields=id,author(id,name),text,created,visibility(permittedGroups(id,name),permittedUsers(id,name))

Sample request body

{ "text": "Jane, please update the information in this article." }

Sample response body

{ "author": { "name": "John Smith", "id": "24-0", "$type": "User" }, "created": 1629984897621, "visibility": { "$type": "UnlimitedVisibility" }, "text": "Jane, please update the information in this article.", "id": "251-2", "$type": "ArticleComment" }
Last modified: 14 September 2021