Get the comments for an issue
Use this request to get a list of comments in the issue.
Request format
To get comments, use an HTTP GET
request:
GET /v2/issues/<issue-id>/comments?
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-Id: <organization ID>
- <issue-id>
- Issue ID or key.
Request for comments from a single issue that specifies the fields to return:
Uses the HTTP GET method.
GET /v2/issues/JUNE-3/comments HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-Id: <organization ID>
Cache-Control: no-cache
Response format
For a successful request, the API returns a 200 response. The response message body contains a JSON array with information about the comments:
[
{
"self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/comments/9849018",
"id": 9849018,
"text": "Comment\n",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
"id": "<user ID>",
"display": "<user's display name>"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
"id": "<user ID>",
"display": "<user's display name>"
},
"createdAt": "2017-06-11T05:11:12.347+0000",
"updatedAt": "2017-06-11T05:11:12.347+0000",
"version": 1
},
...
]
Parameter | Description | Data type |
---|---|---|
self | Reference to the comment object | String. |
id | Comment ID | Integer. |
text | The text of the comment. | String. |
createdBy | Object with information about the user who wrote the comment. | Object. |
updatedBy | Object with information about the user who made the last change to the comment. | Object. |
createdAt | Date and time of comment creation in the format: | String. |
updatedAt | Date and time the comment was updated. | String. |
version | The version of the comment. Each change to the comment increases the version number. | Integer. |
Fields for the createdBy object | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Fields for the updatedBy object | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Parameter | Description | Data type |
---|---|---|
self | Reference to the comment object | String. |
id | Comment ID | Integer. |
text | The text of the comment. | String. |
createdBy | Object with information about the user who wrote the comment. | Object. |
updatedBy | Object with information about the user who made the last change to the comment. | Object. |
createdAt | Date and time of comment creation in the format: | String. |
updatedAt | Date and time the comment was updated. | String. |
version | The version of the comment. Each change to the comment increases the version number. | Integer. |
Fields for the createdBy object | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Fields for the updatedBy object | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Possible response codes
- 200
- The request was successful.
- 404
- The requested object was not found. You might have entered an incorrect object ID or key value.