Developer Portal for YouTrack and Hub Help

Reactions

This resource lets you work with reactions to an article comment.

Resource

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

Returned entity

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

Supported methods

Reaction attributes

Represents a reaction to a comment in YouTrack added by a user.

Attributes

This table describes attributes of the Reaction 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 reaction. Read-only.

author

User

The user who put the reaction. Can be null.

reaction

String

The string representation of the reaction. Can be null.

Read a List of Reactions

Get all accessible reactions to the specific article comment.

Required permissions

Requires permissions: Read Article, Read Article Comment

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of Reaction 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. 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

https://example.youtrack.cloud/api/articles/NP-A-7/comments/4-17/reactions?fields=id,author(login),reaction

Sample response body

[ { "author": { "login": "jane.doe", "$type": "User" }, "reaction": "thanks", "id": "334-0", "$type": "Reaction" }, { "author": { "login": "minnie.terry", "$type": "User" }, "reaction": "thumbs-up", "id": "334-1", "$type": "Reaction" } ]

Add a New Reaction

Add a new reaction to a comment with a specific ID.

Required fields: reaction.

Required permissions

Requires permissions: Read Article, Read Article Comment

Request syntax

POST /api/articles/{articleID}/comments/{commentID}/reactions?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of Reaction 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/4-17/reactions?fields=id,author(login),reaction

Sample request body

{ "author": { "login": "minnie.terry", "id": "24-0", "$type": "User" }, "reaction": "thanks" }

Sample response body

{ "author": { "login": "minnie.terry", "$type": "User" }, "reaction": "thanks", "id": "334-0", "$type": "Reaction" }
Last modified: 19 April 2024