Getting a list of attached files
Written by
Updated at May 6, 2024
The request allows you to get a list of files attached to the entity.
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/entities/<entity_type>/<entity_ID>/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 |
|---|---|---|
| <entity_type> | Entity type:
|
String |
| <entity_ID> | Entity ID. To get the ID, see the entity list. | String |
| <project_or_portfolio_ID> | Project or portfolio ID (the shortId value). You can use it instead of the entity ID in the request. |
String |
Warning
Entity ID is not the same as project or portfolio ID.
Example: Get a list of attachments
- An HTTP GET method is used.
- The response displays information about all the files attached to the entity.
GET /v2/entities/project/<project_ID>/attachments Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID: <organization ID>
Response format
Request executed successfully
Request failed
If the request is successful, the API returns a response with code 200 OK.
The response body contains information about all the files attached to the entity in JSON format.
[
{
"self": "https://api.tracker.yandex.net/v2/attachments/3",
"id": "3",
"name": "Shops.csv",
"content": "https://api.tracker.yandex.net/v2/attachments/3/Shops.csv",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/19********",
"id": "19********",
"display": "Full name",
"cloudUid": "ajeppa7dgp53********",
"passportUid": "15********"
},
"createdAt": "2023-12-25T07:21:36.722+0000",
"mimetype": "text/csv",
"size": 559
},
{
"self": "https://api.tracker.yandex.net/v2/attachments/5",
"id": "5",
"name": "flowers.jpg",
"content": "https://api.tracker.yandex.net/v2/attachments/5/flowers.jpg",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/19********",
"id": "19********",
"display": "Full name",
"cloudUid": "ajeppa7dgp53********",
"passportUid": "15********"
},
"createdAt": "2024-01-11T06:24:57.635+0000",
"mimetype": "image/jpeg",
"size": 20466,
"metadata": {
"size": "236x295"
}
}
]
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | API resource address that contains information about the entity's attachments. | String |
| id | File 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 | File upload date and time 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 API resource with information about the user. | String |
| id | User ID. | Number |
| display | Displayed user name. | String |
| cloudUid | Unique user ID in Yandex Cloud Organization. | String |
| passportUid | Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. | 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:
- 400
- One or more request parameters have an invalid value.
- 404
- The requested object was not found. You may have specified an invalid object ID or key.
- 422
- JSON validation error, the request is rejected.