Getting a list of attached files

Use this request to get a list of files attached to an issue and to comments below it.

GET

https://api.tracker.yandex.net/v3/issues/{issue_ID}/attachments

Query format

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

To get a list of attachments, use an HTTP GET request.

GET /v3/issues/{issue_ID}/attachments
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
Parameter Description Data type
issue_ID Issue ID or key String

Example: Requesting a list of files attached to the issue with the JUNE-2 key.

  • HTTP GET method is used.
GET  https://api.tracker.yandex.net/v3/issues/JUNE-2/attachments

Response format

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

The response body contains a JSON array with a list of attached files.

[
{
  "self" : "FILE_ADDRESS",
  "id" : "FILE_ID",
  "name" : "FILE_NAME",
  "content" : "FILE_DOWNLOAD_ADDRESS",
  "thumbnail" : "PREVIEW_DOWNLOAD_ADDRESS",
  "createdBy" : {
    "self" : "CREATOR_ADDRESS",
    "id" : "CREATOR_LOGIN",
    "display" : "CREATOR_NAME"
  },
  "createdAt" : "FILE_UPLOAD_DATE_AND_TIME",
  "mimetype" : "FILE_TYPE",
  "size" : FILE_SIZE,
  "metadata" : {
    "size" : "IMAGE_DIMENSIONS"
  },
  "commentId" : "COMMENT_ID"
},
...
]
Response parameters
Parameter Description Data type
self Address of the API resource corresponding to the attached file String
id File's unique ID. String
name File name String
content Address of the resource to download the file from String
thumbnail Address of the resource to download the preview thumbnail from; available for image files only String
createdBy Object with information about the user who attached the file Map item
createdAt Date and time when the file is uploaded, in
YYYY-MM-DDThh:mm:ss.sss±hhmm format		 String
mimetype File type, for example:
  • text/plain: Text file
  • image/png: Image in PNG format
 String
size File size in bytes Integer
metadata Object with file metadata Map item
commentId ID of the comment the file is attached to. Returned if the file is attached to a comment rather than to the issue itself. String

createdBy object fields

Parameter Description Data type
self Address of the resource corresponding to the user who uploaded the file String
id Username of the user String
display User's name (as in the interface) String

metadata object fields

Parameter Description Data type
size Image size in pixels String

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

404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Add a reaction to a comment
Next
Get information about an attached file