Contact UsGet started

Attaching a file to an entity

Written by
Updated at May 6, 2024

The request allows you to attach a file to an entity. The About project or About portfolio 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/entities/<entity_type>/<entity_ID>/attachments/<file_ID>
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-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<entity_type> Entity type:
  • Project for a project
  • Portfolio for a portfolio
 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
<file_ID> ID of a temporary file preloaded into Tracker String

Warning

Entity ID is not the same as project or portfolio ID.

Request parameters

Additional parameters

Parameter Description Data type
notify Notify the users specified in the Author, Responsible, Participants, Customers, and Followers fields. The default value is true. Boolean
notifyAuthor Notify the author of the changes. The default value is false. Boolean
fields Additional entity fields to include in the response String
expand Additional information to include in the response:
  • all: All
  • attachments: Attached files
 String

Example: Attaching a file to an entity

  • An HTTP POST method is used.
  • The response displays information about all the attached files.
POST /v2/entities/project/<project_ID>/attachments/30?expand=attachments
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 information about the entity attachment.

{
    "self": "https://api.tracker.yandex.net/v2/entities/project/6586d6fee2b9ef74********",
    "id": "6586d6fee2b9ef74********",
    "version": 78,
    "shortId": 4,
    "entityType": "project",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v2/users/19********",
        "id": "19********",
        "display": "Full name",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": "15********"
    },
    "createdAt": "2023-12-23T12:47:58.405+0000",
    "updatedAt": "2024-01-13T14:06:29.747+0000",
    "attachments": [
        {
            "self": "https://api.tracker.yandex.net/v2/attachments/4",
            "id": "4",
            "name": "newimage.jpg",
            "content": "https://api.tracker.yandex.net/v2/attachments/4/newimage.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
        }
    ]
}
Response parameters
Parameter Description Data type
self Address of the API resource with information about the entity String
id Entity ID String
version Entity version. Each change of the parameters increases the version number. Number
shortId Project or portfolio ID String
entityType Entity type String
createdBy Block with information about the entity creator Object
createdAt Entity creation date in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
updatedAt Date when the entity was last updated, in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
attachments Array of objects with information about the attachment Array of objects

attachments object fields

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:
  • text/plain: Text file
  • image/png: Image in PNG format
 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.
Previous
Getting information about an attached file
Next
Deleting a file