Getting a list of attached files

The request allows you to get a list of files attached to the entity.

GET

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_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/entities/<entity_type>/<entity_ID>/attachments
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_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 Cloud Organization organization is linked to Tracker. Learn more

  • 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 Cloud Organization.

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

Resource
Parameter Description Data type
<entity_type> Entity type:
  • project
  • portfolio
  • goal
 String
<entity_ID> Entity ID. To get the ID, see the entity list. You can use the id or shortId parameter as the ID. String

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 https://api.tracker.yandex.net/v3/entities/project/<project_ID>/attachments

Response format

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/v3/attachments/3",
        "id": "3",
        "name": "Shops.csv",
        "content": "api.tracker.yandex.net/v3/attachments/3/Shops.csv",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/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/v3/attachments/5",
        "id": "5",
        "name": "flowers.jpg",
        "content": "api.tracker.yandex.net/v3/attachments/5/flowers.jpg",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/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 Map item
createdAt File upload date and time 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

createdBy object fields

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 Cloud Organization 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.
Previous
Deleting one item
Next
Getting information about an attached file