Getting comments for the entity

The request allows you to get a list of comments for an entity.

GET

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/comments

Query format

Before making a request, get permission to access the API.

To get comments, use an HTTP GET request.

GET /v3/entities/<entity_type>/<entity_ID>/comments
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

Headers

Host: Address of the node that provides the API.
Authorization: Authorization token about these formats:
- OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more
- Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
X-Org-ID or X-Cloud-Org-ID: Organization ID.
- Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.
- Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Parameter	Description	Data type
<entity_type>	Entity type: project portfolio goal	String
<entity_ID>	Entity ID. To get the ID, see the entity list. You can use the `id` or `shortId` parameter as the ID.	String

Request parameters

Additional parameters

Parameter	Description	Data type
expand	Additional information to include in the response: `all`: All `html`: Comment HTML markup `attachments`: Attached files `reactions`: Reactions to a comment	String

Example: Getting a list of comments

An HTTP GET method is used.

The response displays information about all comments.
GET https://api.tracker.yandex.net/v3/entities/project/<project_ID>/comments?expand=all

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about entity comments in JSON format.

[
    {
        "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********/comments/15",
        "id": 15,
        "longId": "65a156a29d5d2000********",
        "text": "Comment **number one.**",
        "textHtml": "<p>Comment <strong>number one.</strong></p>\n",
        "attachments": [
            {
                "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********/attachments/25",
                "id": "25",
                "display": "image.jpg"
            }
        ],
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/19********",
            "id": "19********",
            "display": "Full name",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": "15********"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v3/users/19********",
            "id": "19********",
            "display": "Full name",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": "15********"
        },
        "createdAt": "2024-01-12T15:11:30.278+0000",
        "updatedAt": "2024-01-12T16:33:35.988+0000",
        "usersReacted": {
            "like": [
                {
                    "self": "https://api.tracker.yandex.net/v3/users/19********",
                    "id": "19********",
                    "display": "Full name",
                    "cloudUid": "ajeppa7dgp71********",
                    "passportUid": "16********"
                }
            ]
        },
        "ownReactions": ["like"],
        "summonees": [
            {
                "self": "https://api.tracker.yandex.net/v3/users/19********",
                "id": "19********",
                "display": "Full name",
                "cloudUid": "ajeppa7dgp32********",
                "passportUid": "12********"
            }
        ],
        "version": 3,
        "type": "standard",
        "transport": "internal"
    }
]

Response parameters

Parameter	Description	Data type
self	Link to the comment object.	String
id	Comment ID.	Number
longId	Comment ID as a string.	String
text	Text of the comment.	String
textHtml	Comment HTML markup	String
attachments	Attached files	String
createdBy	Object with information about the author of the comment	Map item
updatedBy	Object with information about the last user to have updated the comment	Map item
createdAt	Comment creation date and time in the format: `YYYY-MM-DDThh:mm:ss.sss±hhmm`	String
updatedAt	Comment update date and time in the format: `YYYY-MM-DDThh:mm:ss.sss±hhmm` .	String
usersReacted	User reactions (present in the response if the `expand` parameter in the request is set to `all` or `reactions`): `like` `dislike` `laugh` `tada` `hooray` `confused` `heart` `rocket` `eyes` `fire` `ok` `facepalm` `check`	Object with a list of reactions and responders
reactionsCount	Number of reactions (present in the response if the `expand` parameter in the request is not set to `all` or `reactions`).	Object with a list and number of reactions
ownReactions	Reactions of the comment author: `like` `dislike` `laugh` `tada` `hooray` `confused` `heart` `rocket` `eyes` `fire` `ok` `facepalm` `check`	List of strings
summonees	IDs or usernames of summoned users.	Array of objects or strings
maillistSummonees	List of mailing lists mentioned in the comment.	Array of strings
version	Comment version. Each update increases the comment's version number.	Number
type	Comment type: `standard`: Comment sent via the Tracker interface. `incoming`: Comment created from an incoming message. `outcoming`: Comment created from an outgoing message.	String
transport	Method of adding a comment: `internal`: Via the Tracker interface. `email`: Via email.	String

createdBy object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user	String
id	User ID.	String
display	Displayed user name	String
passportUid	Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID.	Number
cloudUid	Unique user ID in Yandex Cloud Organization	String

updatedBy object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user	String
id	User ID.	String
display	Displayed user name	String
passportUid	Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID.	Number
cloudUid	Unique user ID in Yandex Cloud Organization	String

usersReacted object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user	String
id	User ID.	String
display	Displayed user name	String
passportUid	Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID.	Number
cloudUid	Unique user ID in Yandex Cloud Organization	String

If the request is processed incorrectly, the API returns a response with an error code:

400: One or more request parameters have an invalid value.

404: The requested object was not found. You may have specified an invalid object ID or key.

422: JSON validation error, the request is rejected.

Paginated display of entity comments

For paginated display of results, use an HTTP GET request.

GET /v3/entities/<entity_type>/<entity_ID>/comments/_relative
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

Specify additional parameters in the query string:

Parameter	Description	Data type
perPage	Defines the maximum number of comments in a response. The default value is 50.	Number
from	ID of the comment after which the list starts to be generated. The comment itself is not included in the list. Not used together with the `selected` parameter.	String
selected	ID of the comment around which the list is generated. Not specified together with the `from` parameter. The list is generated in the following order (for `perPage=5`): Comment with the specified ID. Comment preceding the first comment. Comment following the first comment. Comment preceding the second comment. Comment following the third comment.	String
newCommentsOnTop	Reverses the order of comments in the list. The default value is `false`.	Boolean
direction	Determines the order of comments in the list: `forward` (default) `backward`: Inverts the `newCommentsOnTop` parameter value.	String

If no parameters are specified, the full list of entities is displayed.

Example: Getting a list of comments

An HTTP GET method is used.

The response displays information about three comments starting with 65a1bdbdb02b780b31********.
GET https://api.tracker.yandex.net/v3/entities/project/<project_ID>/comments/_relative?perPage=3&from=65a1bdb02b780b31********

Response format with paginated comments

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about entity comments in JSON format.

{
    "comments": [
        {
            "self": "https://api.tracker.yandex.net/v3/entities/project/65a1bdb02b780b31********/comments/22",
            "id": 22,
            "longId": "65a1bdb02b780b31********",
            "text": "Previous comment.",
            ...
        },
        {
            "self": "https://api.tracker.yandex.net/v3/entities/project/65a1bdb02b780b32********/comments/23",
            "id": 23,
            "longId": "65a1bdb02b780b32********",
            "text": "Specified comment.",
            ...
        },
        {
            "self": "https://api.tracker.yandex.net/v3/entities/project/65a1bdb02b780b33********/comments/24",
            "id": 24,
            "longId": "65a1bdb02b780b33********",
            "text": "Next comment.",
            ...
        }
    ],
    "hasNext": True,
    "hasPrev": True
}

Response parameters

Parameter	Description	Data type
comments	List of comments.	List of objects
hasNext	Indicates the presence of subsequent entries in the list.	Boolean
hasPrev	Indicates the presence of previous entries in the list.	Boolean

If the request is processed incorrectly, the API returns a response with an error code:

400: One or more request parameters have an invalid value.

404: The requested object was not found. You may have specified an invalid object ID or key.

422: JSON validation error, the request is rejected.

Was the article helpful?

Editing a comment

Getting a comment