Operations with Specific ArticleComment

This resource lets you work with comments to an article.

Resource	/api/articles/{articleID}/comments/{commentID}
Returned entity	ArticleComment. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific ArticleComment. `POST`: Update a Specific ArticleComment. `DELETE`: Delete a Specific ArticleComment.

ArticleComment attributes

Represents a comment to an article.

Related Resources

Below you can find the list of resources that let you work with this entity.

Article Comments

Attributes

This table describes attributes of the ArticleComment entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the article comment. `Read-only`.
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.
author	User	The user who created the comment. `Read-only`. `Can be null`.
created	Long	The timestamp in milliseconds indicating the moment when the comment was posted. Stored as a unix timestamp at UTC. `Read-only`.
pinned	Boolean	Determines whether the comment is pinned in the article.
reactions	Array of Reactions	The list of reactions that users added to this comment.
text	String	The text of the comment. `Can be null`.
updated	Long	The timestamp in milliseconds indicating the last update of the comment. Stored as a unix timestamp at UTC. `Read-only`.
visibility	Visibility	The visibility settings of the comment. They define who is allowed to see the comment. `Can be null`.

Read a Specific ArticleComment

Read a comment with a specific ID.

Required permissions

Requires read access to the article. If a user is the author of the comment, comment is always visible to them.

Request syntax

GET /api/articles/{articleID}/comments/{commentID}?{fields}

{commentID}

The database ID of the comment.

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.

Sample

Sample request

                https://example.youtrack.cloud/api/articles/NP-A-7/comments/251-0?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"
                }
            

Update a Specific ArticleComment

Update an existing comment to a specific article.

Required permissions

Requires Update Comment permission for own comments and Update Not Own Comment permission for not own comments.

Request syntax

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

{commentID}

The database ID of the comment.

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.
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.youtrack.cloud/api/articles/NP-A-7/comments/251-1?fields=id,author(id,name),text,created,visibility(permittedGroups(id,name),permittedUsers(id,name))
            

Sample request body

                {
                  "text": "Okay, I will do it, @john.smith. By the way, I am updating this comment using REST API."
                }
            

Sample response body

                {
                  "author": {
                    "name": "Jane Doe",
                    "id": "24-1",
                    "$type": "User"
                  },
                  "created": 1629984781870,
                  "visibility": {
                    "$type": "UnlimitedVisibility"
                  },
                  "text": "Okay, I will do it, @john.smith. By the way, I am updating this comment using REST API.",
                  "id": "251-1",
                  "$type": "ArticleComment"
                }
            

Delete a Specific ArticleComment

Delete an existing comment to a specific article.

Required permissions

Requires Delete Comment permission for own comments and Delete Not Own Comment permission for not own comments.

Request syntax

DELETE /api/articles/{articleID}/comments/{commentID}

{commentID}

The database ID of the comment.

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.

Sample

Sample request

https://example.youtrack.cloud/api/articles/NP-A-7/comments/251-1

Last modified: 7 November 2024