Attaching a file to an issue using an API request
Use this request to attach a file to an issue. The Attachments tab will display the attached file.
Request format
Before making the request, get permission to access the API.
To attach a file, use an HTTP POST request:
POST /v2/issues/<issue_ID_or_key>/attachments/
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Content-Type: multipart/form-data
<file>
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. If you only have a Yandex Cloud Organization organization, use the
X-Cloud-Org-IDheader; if only Yandex 360 for Business or both organization types, useX-Org-ID. -
Content-Type
Request body format. The required value is
multipart/form-data.
Resource
| Parameter | Description | Data type |
|---|---|---|
| <issue_ID_or_key> | Issue ID or key | String |
Request parameters
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| <new_file_name> | New name that a file will be stored on the server as | String |
Request body parameters
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| <file> | Binary file up to 1024 Mb | File |
Response format
If the request is successful, the API returns a response with code 201 Created.
The response body contains the parameters of the attached file in JSON format.
{
"self": "<file_address>",
"id": "<file_ID>",
"name": "<file_name>",
"content": "<file_download_address>",
"thumbnail": "<preview_download_address>",
"createdBy": {
"self": "<creator_address>",
"id": "<creator_username>",
"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.