Developer Portal for YouTrack and Hub 2021.3 Help

ArticleAttachment

Represents a file that is attached to an article or a comment to an article.

This table describes attributes of the ArticleAttachment entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

name

String

The name of the file. Can be null.

author

User

The user who attached the file to the article. Read-only. Can be null.

created

Long

The timestamp of the date and time when the attachment was created. Read-only.

updated

Long

The timestamp of the date and time when the attachment was last updated. Read-only.

size

Long

The size of the attached file in bytes. Read-only.

extension

String

The extension that defines the file type. Read-only. Can be null.

charset

String

The charset of the file. Read-only. Can be null.

mimeType

String

The MIME type of the file. Read-only. Can be null.

metaData

String

The dimensions of an image file. For an image file, the value is rw=&rh=. For a non-image file, the value is empty. Read-only. Can be null.

draft

Boolean

If true, the attachment is not yet published, otherwise false. Read-only.

removed

Boolean

If true, the attachment is considered to be removed. Read-only.

base64Content

String

The data URI that represents the attachment with the following syntax:

data:[<media type>][;base64],<data>

For example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Can be null.

url

String

The URL of the file. Read-only. Can be null.

visibility

Visibility

The visibility settings of the attachment. Can be null.

article

BaseArticle

The article that the file is attached to. Read-only. Can be null.

comment

ArticleComment

The comment that the file is attached to. Returns null if the file was attached directly to the article. Read-only.

Last modified: 14 September 2021