Issue Attachments
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 |
|
IssueAttachment attributes
Represents a file that is attached to an issue or a comment.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
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 | User | 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: Can be null. |
url | String | URL of the file. |
visibility | Visibility | Access setting of the attachment. |
issue | Issue | The issue that the file is attached to. |
comment | IssueComment | The comment that the file is attached to. Returns |
thumbnailURL | String | URL of the attachment thumbnail. |
Read a List of IssueAttachments
Get a list of all attachments of the specific issue.
Required permissions
Requires access to the issue where the attachment belongs.
Request syntax
GET /api/issues/{issueID}/attachments?{fields}&{$top}&{$skip}Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueAttachment attributes that should be returned in the response. If no field is specified, only the |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
Sample
Sample request
https://example.youtrack.cloud/api/issues/2-6/attachments?fields=id,name,author(id,name),created,updated,size,mimeType,extension,charset,metaData,urlSample response body
[
{
"created": 1554209839634,
"updated": 1554209839578,
"author": {
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
"metaData": "rw=568&rh=902",
"charset": null,
"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"
},
{
"created": 1554209920779,
"updated": 1554209920719,
"author": {
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
"metaData": "rw=375&rh=226",
"charset": null,
"name": "older-versions.png",
"size": 23812,
"extension": "png",
"url": "/youtrack/api/files/1-2/sign=fake",
"mimeType": "image/png",
"id": "7-3",
"$type": "IssueAttachment"
},
{
"created": 1554223990031,
"updated": 0,
"author": {
"name": "Jane Doe",
"id": "1-3",
"$type": "User"
},
"metaData": "rw=375&rh=226",
"charset": null,
"name": "older-versions.png",
"size": 23812,
"extension": "png",
"url": "/youtrack/api/files/1-3/sign=fake",
"mimeType": "image/png",
"id": "7-6",
"$type": "IssueAttachment"
},
{
"created": 1554223990031,
"updated": 0,
"author": {
"name": "Jane Doe",
"id": "1-3",
"$type": "User"
},
"metaData": "empty",
"charset": null,
"name": "readme-rest-docs.md",
"size": 3503,
"extension": "md",
"url": "/youtrack/api/files/1-4/sign=fake",
"mimeType": "text/markdown",
"id": "7-7",
"$type": "IssueAttachment"
}
]Add a New IssueAttachment
Add an attachment to the issue.
Required permissions
Requires permissions: Add Attachment
Request syntax
POST /api/issues/{issueID}/attachments?{fields}&{muteUpdateNotifications}Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueAttachment attributes that should be returned in the response. If no field is specified, only the |
muteUpdateNotifications | Boolean | Set this parameter to |
Sample
To create an attachment in an issue, you need to send a POST request to an endpoint like the one specified in this sample. As the format for request differs for various languages and tools, we do not provide specific example here. Instead, see a sample step-by-step procedure on the use case page.
Sample request
https://example.youtrack.cloud/api/issues/2-6/attachments?fields=id,name,author(id,name),created,updated,size,mimeType,extension,charset,metaData,url