Attaching a file to an entity

The request allows you to attach a file to an entity.

POST

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/attachments/<file_ID>

Query format

Before making a request, get permission to access the API.

To attach a file, use an HTTP POST request:

POST /v3/entities/<entity_type>/<entity_ID>/attachments/<file_ID>
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. String
<file_ID> ID of a temporary file preloaded into Tracker String
Request parameters

Additional parameters

Parameter Description Data type
notify Notify the users specified in the Author, Lead, 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.
  • Attach a temporary file with ID 30 to a project.
  • The response provides information about all attached files.
POST https://api.tracker.yandex.net/v3/entities/project/<project_ID>/attachments/30?expand=attachments

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/v3/entities/project/6586d6fee2b9ef74********",
    "id": "6586d6fee2b9ef74********",
    "version": 78,
    "shortId": 4,
    "entityType": "project",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/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/v3/attachments/4",
            "id": "4",
            "name": "newimage.jpg",
            "content": "api.tracker.yandex.net/v3/attachments/4/newimage.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
        }
    ]
}
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.
Entity edits will be disabled if the version number reaches the threshold value of 10100 (for robots) or 11100 (for users).		 Number
shortId Goal, project, or portfolio ID in the Tracker interface String
entityType Entity type String
createdBy Block with information about the entity creator Map item
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 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.
423
Object edits disabled. The version parameter value limit (the maximum number of object updates) might have been exceeded. The maximum version value is 10100 for robots and 11100 for users.
Previous
Getting information about an attached file
Next
Deleting a file