Article Comments
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 | |
Supported sub-resources |
|
Represents a comment to an article.
Below you can find the list of resources that let you work with this entity.
Article Comments
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. |
Get all accessible comments to a specific article.
GET /api/articles/{articleID}/comments?{fields}&{$top}&{$skip}null | Database ID of ArticleComment |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ArticleComment attributes that should be returned in the response. If no field is specified, only the |
$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. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
https://example.youtrack.cloud/api/articles/NP-A-7/comments?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"
}
]Add a new comment to the article.
Required fields: text.
Requires permissions: Create Comment
POST /api/articles/{articleID}/comments?{fields}&{draftId}&{muteUpdateNotifications}null | Database ID of ArticleComment |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ArticleComment attributes that should be returned in the response. If no field is specified, only the |
draftId | String | The ID of an existing draft that should be published. This parameter is optional. |
muteUpdateNotifications | Boolean | Set this parameter to |
https://example.youtrack.cloud/api/articles/NP-A-7/comments?fields=id,author(id,name),text,created,visibility(permittedGroups(id,name),permittedUsers(id,name)){
"text": "Jane, please update the information in this article."
}{
"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"
}