Operations with Specific IssueAttachment
This resource lets you work with attachments in the specific issue.
Resource | |
|---|---|
Returned entity | IssueAttachment. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents a file that is attached to an issue or a comment.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the IssueAttachment entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the attachment. |
name | String | The name of the file. |
author | The user who attached the file to the issue. | |
created | Long | The timestamp in milliseconds indicating the moment when the attachment was created. Stored as a unix timestamp at UTC. |
updated | Long | The timestamp in milliseconds indicating the last update of the attachment. Stored as a unix timestamp at UTC. |
size | Long | The size of the attached file in bytes. |
extension | String | The extension that defines the file type. |
charset | String | Charset of the file. |
mimeType | String | Mime type of the file. |
metaData | String | The dimensions of an image file. For an image file, the value is |
draft | Boolean | If true, attachment is not yet published, otherwise false. |
removed | Boolean | If true, then attachment is considered to be removed. |
base64Content | String | The Data URI that represents the attachment with the following syntax: For example: |
url | String | URL of the file. |
visibility | Access setting of the attachment. | |
issue | The issue that the file is attached to. | |
comment | The comment that the file is attached to. Returns | |
thumbnailURL | String | URL of the attachment thumbnail. |
Read a specific attachment of the issue.
Requires read access to the issue where the attachment belongs.
If the attachment is added to a comment, access to this comment is also required.
If the attachment visibility is limited to specific groups or users, only users from this set and attachment author will be able to access the attachment. Override Visibility Restrictions permissions allows to override these limitations.
GET /api/issues/{issueID}/attachments/{attachmentID}?{fields}{attachmentID} | Database ID of the attachment. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueAttachment attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/issues/2-6/attachments/7-2?fields=id,name,author(id,name),created,updated,size,mimeType,extension,metaData,url{
"created": 1554209839634,
"updated": 1554209839578,
"author": {
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
"metaData": "rw=568&rh=902",
"name": "2019-03-28_14-30-46.png",
"size": 208788,
"extension": "png",
"url": "/youtrack/api/files/1-1/sign=fake",
"mimeType": "image/png",
"id": "7-2",
"$type": "IssueAttachment"
}Update a specific attachment.
The author of the attachment can always update it. Otherwise, requires Update Attachment permission.
POST /api/issues/{issueID}/attachments/{attachmentID}?{fields}{attachmentID} | Database ID of the attachment. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueAttachment attributes that should be returned in the response. If no field is specified, only the |
For an existing attachment, you can update only its name, visibility settings, and base64Content, if applicable. For this sample, we just re-name the attached image file.
https://example.youtrack.cloud/api/issues/2-6/attachments/7-2?fields=id,name,author(id,name),created,updated,size,mimeType,extension,metaData,url{ "name":"orphan-modules.png" }{
"created": 1554209839634,
"updated": 1569436739288,
"author": {
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
"metaData": "rw=568&rh=902",
"name": "orphan-modules.png",
"size": 208788,
"extension": "png",
"url": "/youtrack/api/files/1-1/sign=fake",
"mimeType": "image/png",
"id": "7-2",
"$type": "IssueAttachment"
}Delete a specific attachment.
The author of the attachment can always delete it. Otherwise, requires Delete Attachment permission.
DELETE /api/issues/{issueID}/attachments/{attachmentID}{attachmentID} | Database ID of the attachment. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueAttachment attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/issues/2-6/attachments/7-2