Operations with Specific ArticleComment
This resource lets you work with comments to an article.
Resource | |
|---|---|
Returned entity | ArticleComment. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents a comment to an article.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the ArticleComment entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest 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. |
article | The article the comment belongs to. | |
attachments | The list of attachments that are attached to the comment. | |
author | The user who created the comment. | |
created | Long | The timestamp in milliseconds indicating the moment when the comment was posted. Stored as a unix timestamp at UTC. |
pinned | Boolean | Determines whether the comment is pinned in the article. |
reactions | The list of reactions that users added to this comment. | |
text | String | The text of the comment. |
updated | Long | The timestamp in milliseconds indicating the last update of the comment. Stored as a unix timestamp at UTC. |
visibility | The visibility settings of the comment. They define who is allowed to see the comment. |
Read a comment with a specific ID.
Requires read access to the article. If a user is the author of the comment, comment is always visible to them.
GET /api/articles/{articleID}/comments/{commentID}?{fields}{commentID} | The database ID of the comment. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ArticleComment attributes that should be returned in the response. If no field is specified, only the |
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)){
"author": {
"name": "John Smith",
"id": "24-0",
"$type": "User"
},
"created": 1629984248559,
"visibility": {
"$type": "UnlimitedVisibility"
},
"text": "Hello world!",
"id": "251-0",
"$type": "ArticleComment"
}Update an existing comment to a specific article.
Requires Update Comment permission for own comments and Update Not Own Comment permission for not own comments.
POST /api/articles/{articleID}/comments/{commentID}?{fields}&{muteUpdateNotifications}{commentID} | The database ID of the comment. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ArticleComment attributes that should be returned in the response. If no field is specified, only the |
muteUpdateNotifications | Boolean | Set this parameter to |
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)){
"text": "Okay, I will do it, @john.smith. By the way, I am updating this comment using REST API."
}{
"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 an existing comment to a specific article.
Requires Delete Comment permission for own comments and Delete Not Own Comment permission for not own comments.
DELETE /api/articles/{articleID}/comments/{commentID}{commentID} | The database ID of the comment. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ArticleComment attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/articles/NP-A-7/comments/251-1