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 |
|
Supported sub-resources |
|
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.
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. |
article | Article | The article the comment belongs to. |
attachments | Array of ArticleAttachments | The list of attachments that are attached to the comment. |
author | User | 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 | Array of 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 | Visibility | The visibility settings of the comment. They define who is allowed to see the comment. |
Read a List of ArticleComments
Get all accessible comments to a specific article.
Request syntax
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 |
$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. |
Sample
Sample request
Sample response body
Add a New ArticleComment
Add a new comment to the article.
Required fields: text
.
Required permissions
Requires permissions: Create Comment
Request syntax
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 |
draftId | String | The ID of an existing draft that should be published. This parameter is optional. |
muteUpdateNotifications | Boolean | Set this parameter to |