Getting a list of attached files
Use this request to get a list of files attached to an issue and to comments below it.
Request format
Before making the request, get permission to access the API.
To get a list of attachments, use an HTTP GET request.
GET /v2/issues/<issue_ID_or_key>/attachments
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net -
Authorization
OAuth token in
OAuth <OAuth_token>format, e.g.:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Resource
| Parameter | Description | Data type |
|---|---|---|
| <issue_ID_or_key> | Issue ID or key | String |
Example: Request a list of files attached to the issue with the
JUNE-2key.
- An HTTP
GETmethod is used.GET /v2/issues/JUNE-2/attachments HTTP/1.1 Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth token> X-Org-ID: <organization ID>
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>"
}
},
...
]
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 | Object |
| createdAt | Date and time when the file is uploaded, in YYYY-MM-DDThh:mm:ss.sss±hhmm format |
String |
| mimetype | File type, for example:
|
String |
| size | File size in bytes. | Integer |
| metadata | Object with file metadata | Object |
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.