Get an issue comment

Use this request to get a comment on an issue.

GET

https://api.tracker.yandex.net/v3/issues/{issue_id}/comments/{comment_id}

Request format

Before making the request, get access to the API.

To get a comment, use an HTTP GET request:

GET /v3/issues/{issue_id}/comments/{comment_id}
Host: api.tracker.yandex.net
Authorization: OAuth API_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 Identity Hub organization is linked to Tracker. Learn more

  • ID types

    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 Identity Hub.

    Finding the ID

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Required parameters

Parameter Description Data type
issue_id Issue ID or key. String
comment_id Unique comment ID in numeric id or string longId format. String or number
Request parameters

Additional parameters

Parameter Description Data type
expand Additional fields to include in the response:
  • attachments: Attached files.
  • html: Comment HTML markup.
  • all: All additional fields.
 String

Example: Get a comment

GET https://api.tracker.yandex.net/v3/issues/JUNE-2/comments/123456

Response format

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

The response body contains comment information in JSON format.

{
    "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/comments/123456",
    "id": 123456,
    "longId": "5fa15a24ac894475********",
    "text": "My **first** comment",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "User Name"
    },
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "User Name"
    },
    "createdAt": "2017-06-11T05:11:12.347+0000",
    "updatedAt": "2017-06-11T05:11:12.347+0000",
    "version": 1,
    "type": "standard",
    "transport": "internal"
}

Response parameters

Parameter Description Data type
self URL of the API resource that represents the comment. String
id Comment ID. Number
longId Comment ID in string format. String
text Comment text. String
createdBy Object with information about the comment author. Object
updatedBy Object with information about the user who last changed the comment. Object
createdAt Comment creation date and time. String
updatedAt Date and time when the comment was last changed. String
version Comment version. Number
type Comment type. String
transport Method used to add the comment. String

Fields of the createdBy and updatedBy objects

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 Identity Hub String

If the If-None-Match header contains the ETag value from a previous response, the API returns 304 when the comment has not changed. The response body is empty.

Previous
Get issue comments
Next
Edit a comment