# Article

Represents an article in YouTrack.

Extends [BaseArticle](v1-BaseArticle.html).

Available since 2021.4.23500

## Properties

| Name | Type | Description |
| --- | --- | --- |
| attachments |  [Set](v1-Set.html).<[BaseArticleAttachment](v1-BaseArticleAttachment.html)>  | Read-only.  The set of attachments that are attached to the article.   |
| author |  [User](v1-User.html)  | Read-only.  The user who created the article.   |
| becomesRemoved |  Boolean  | Read-only.  When `true`, the entity is removed in the current transaction. Otherwise, `false`. This property can become `true` only in on-change rules when the rule is triggered on the removal of an issue or an article. In the rule code, the `runOn` rule property must contain the `removal` parameter set to `true`.             Available since 2017.4.37915      ```JAVASCRIPT runOn: {removal: true} ```    |
| childArticles |  [Set](v1-Set.html).<[Article]()>  |  The set of sub-articles of the current one.             Available since 2024.4    |
| comments |  [Set](v1-Set.html).<[ArticleComment](v1-ArticleComment.html)>  | Read-only.  The set of comments for the article or article draft.   |
| content |  String  |  The text that is entered as the article content.   |
| created |  Number  | Read-only.  The date when the article was created.   |
| editedComments |  [Set](v1-Set.html).<[ArticleComment](v1-ArticleComment.html)>  | Read-only.  The set of comments that are edited in the current transaction.     Comments that are added and removed are not considered to be edited. Instead, these are represented by the `article.comments.added` and `article.comments.removed` properties.    |
| extensionProperties |  Object  |  The object containing extension properties for this entity and their values. Extension properties are custom properties that might be added to core YouTrack entities by an app. For details about extension properties, see [Extension Properties](apps-extension-properties.html).             Available since 2024.3      ```JAVASCRIPT const entities = require('@jetbrains/youtrack-scripting-api/entities');  exports.rule = entities.Issue.action({     command: 'test',     action: function (ctx) {         const printValues = () => {             return 'stringProp:' + ctx.issue.extensionProperties.stringProp + ';'                 + 'integerProp:' + ctx.issue.extensionProperties.integerProp + ';'                 + 'booleanProp:' + ctx.issue.extensionProperties.booleanProp + ';'                 + 'issueProp:' + ctx.issue.extensionProperties.issueProp?.id + ';'                 + 'issuesProp:' + ctx.issue.extensionProperties.issuesProp?.first()?.id + ';'         }         ctx.issue.addComment(printValues());     } }); ```    |
| id |  String  | Read-only.  The article ID.   |
| isNew |  Boolean  | Read-only.  When `true`, the entity is created in the current transaction. Otherwise, `false`.             Available since 2018.2.42351    |
| isStarred |  Boolean  | Read-only.  If the current user has added the &apos;Star&apos; to watch the article, this property is `true`.             Available since 2023.1    |
| numberInProject |  Number  | Read-only.  The article number in the project.   |
| originalArticle |  [Article]()  | Read-only.  The article from which the current article draft was created, or `null` if the current article is not a draft.             Available since 2026.1    |
| parentArticle |  [Article]()  |  The parent article of the current one.             Available since 2024.4    |
| permittedGroups |  [Set](v1-Set.html).<[UserGroup](v1-UserGroup.html)>  |  The groups for which the article is visible when the visibility is restricted to multiple groups.             Available since 2026.1    |
| permittedUsers |  [Set](v1-Set.html).<[User](v1-User.html)>  |  The list of users for whom the article is visible.             Available since 2026.1    |
| pinnedComments |  [Set](v1-Set.html).<[ArticleComment](v1-ArticleComment.html)>  | Read-only.  The set of comments that are pinned in the article or draft.             Available since 2024.1    |
| project |  [Project](v1-Project.html)  |  The project to which the article is assigned.   |
| summary |  String  |  The article title.   |
| tags |  [Set](v1-Set.html).<[Tag](v1-Tag.html)>  |  The list of tags that are attached to the article.             Available since 2023.1    |
| updated |  Number  | Read-only.  The date when the article was last updated.   |
| updatedBy |  [User](v1-User.html)  | Read-only.  The user who last updated the article.   |
| url |  String  | Read-only.  The absolute URL that points to the article.             Available since 2025.1    |

## Constructors

### Article

```JAVASCRIPT
Article(author, project, summary)
```

Available since 2021.4.23500

Parameters

| Name | Type | Description |
| --- | --- | --- |
| author |  [User](v1-User.html), [JsonForArticleConstructor](v1-JsonForArticleConstructor.html)  |  The author of the article. Alternatively, pass a JSON specified by [JsonForArticleConstructor](v1-JsonForArticleConstructor.html)                     |
| project |  [Project](v1-Project.html)  |  The project where the new article is created.                     |
| summary |  String  |  The article title.                     |

## Methods

### action

```JAVASCRIPT
static action(ruleProperties)
```

Creates a declaration of a rule that a user can apply to an article using a menu option. The object that is returned by this method is normally exported to the `rule` property, otherwise it is not treated as a rule.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | ruleProperties |  Object  |  A JSON object that defines the properties for the rule.                     |

Properties of ruleProperties
: | Name | Type | Description |
: | --- | --- | --- |
: | title |  string  |  The human-readable name of the rule. Displayed in the administrative UI in YouTrack.                     |
: | userInput |  Object  |  An object that defines the properties for information that will be requested from the user who triggers the action rule.                     |
: | userInput.type |  string, Object  |    The data type for the value that is requested from the user.     The supported types are [entities.Field.dateTimeType](v1-Field.html), [entities.Field.dateType](v1-Field.html), [entities.Field.integerType](v1-Field.html), [entities.Field.floatType](v1-Field.html), [entities.Field.periodType](v1-Field.html), [entities.Field.stringType](v1-Field.html), [entities.Build](v1-Build.html), [entities.EnumField](v1-EnumField.html), [entities.Issue](v1-Issue.html), [entities.IssueTag](v1-IssueTag.html), [entities.OwnedField](v1-OwnedField.html), [entities.Project](v1-Project.html), [entities.ProjectVersion](v1-ProjectVersion.html), [entities.UserGroup](v1-UserGroup.html), and [entities.User](v1-User.html).    |
: | userInput.description |  string  |  The label for the control that is used to collect additional information from the user.                     |
: | guard |  [Article]()~guardFunction  |  A function that is invoked to determine whether the action is applicable to an article.                     |
: | action |  [Article]()~actionFunction  |  The function that is invoked when a user triggers this action.                     |
: | requirements |  [Requirements](v1-Requirements.html)  |  The set of entities that must be present for the script to work as expected.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  Object  |  The object representation of the rule.                 |

Example
: ```JAVASCRIPT
: var entities = require('@jetbrains/youtrack-scripting-api/entities');
: exports.rule = entities.Article.action({
: title: 'Log article comments',
: command: 'log',
: guard: function(ctx) {
: return ctx.article.comments.isEmpty();
: },
: action: function(ctx) {
: ctx.article.comments.forEach(function(comment) {
: console.log(comment.text);
: });
: }
: });
: ```

### createDraft

```JAVASCRIPT
static createDraft(project, author)
```

Creates a new article draft.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | project |  [Project](v1-Project.html)  |  The project where the new article draft is created.                     |
: | author |  [User](v1-User.html)  |  The author of the article draft.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  ArticleDraft  |  The newly created article draft.                 |

### findByExtensionProperties

```JAVASCRIPT
static findByExtensionProperties(extensionPropertiesQuery)
```

Searches for Article entities with extension properties that match the specified query.

Available since 2024.3.43260

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | extensionPropertiesQuery |  Object  |  The extension properties query, defined as a set of key-value pairs representing properties and their corresponding values.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [Set](v1-Set.html).<[Article]()>  |  The set of Article entities that contain the specified extension properties.                 |

Example
: ```JAVASCRIPT
: {
: property1: "value1",
: property2: "value2"
: }
: ```

### findById

```JAVASCRIPT
static findById(id)
```

Finds an article by its visible ID.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | id |  String  |  The article ID.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [Article]()  |  The article that is assigned the specified ID.                 |

### onChange

```JAVASCRIPT
static onChange(ruleProperties)
```

Creates a declaration of a rule that is triggered when a change is applied to an article. The object that is returned by this method is normally exported to the `rule` property, otherwise it is not treated as a rule.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | ruleProperties |  Object  |  A JSON object that defines the properties for the rule.                     |

Properties of ruleProperties
: | Name | Type | Description |
: | --- | --- | --- |
: | title |  string  |  The human-readable name of the rule. Displayed in the administrative UI in YouTrack.                     |
: | guard |  [Article]()~guardFunction  |  A function that determines the conditions for executing the rule. If the guard condition is not met, the action specified in the rule is not applied to the article.                     |
: | action |  [Article]()~actionFunction  |  The function that is invoked on an article change.                     |
: | requirements |  [Requirements](v1-Requirements.html)  |  The set of entities that must be present for the script to work as expected.                     |
: | runOn |  Object  |  Determines which article events trigger the on-change rule. When not specified, the rule is triggered on an article change.                     |
: | runOn.change |  boolean  |  When `true`, the rule is triggered on an article change.                     |
: | runOn.removal |  boolean  |  When `true`, the rule is triggered when an article is logically deleted.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  Object  |  The object representation of the rule.                 |

Example
: ```JAVASCRIPT
: var entities = require('@jetbrains/youtrack-scripting-api/entities');
: exports.rule = entities.Article.onChange({
: title: 'On article change, log its ID',
: action: function(ctx) {
: console.log(ctx.article.id);
: }
: });
: ```

### addAttachment

```JAVASCRIPT
addAttachment(content, name, charset, mimeType)
```

Attaches a file to the article. Makes `article.attachments.isChanged` return `true` for the current transaction.

Available since 2020.2

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | content |  InputStream, String, [JsonForArticleAddAttachment](v1-JsonForArticleAddAttachment.html)  |  The content of the file in binary or base64 form. Alternatively, pass a JSON specified by [JsonForArticleAddAttachment](v1-JsonForArticleAddAttachment.html)                     |
: | name |  String  |  The name of the file.                     |
: | charset |  String  |  The charset of the file. Only applicable to text files.                     |
: | mimeType |  String  |  The MIME type of the file.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [ArticleAttachment](v1-ArticleAttachment.html)  |  The attachment that is added to the article.                 |

### addComment

```JAVASCRIPT
addComment(text, author)
```

Adds a comment to the article.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | text |  String, [JsonForArticleAddComment](v1-JsonForArticleAddComment.html)  |  The text to add to the article as a comment. Alternatively, pass a JSON specified by [JsonForArticleAddComment](v1-JsonForArticleAddComment.html)                     |
: | author |  [User](v1-User.html)  |  The author of the comment.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [ArticleComment](v1-ArticleComment.html)  |  A newly created comment.                 |

### addTag

```JAVASCRIPT
addTag(name)
```

Adds a tag with the specified name to an article. YouTrack adds the first matching tag that is visible to the current user. If a match is not found, a new private tag is created for the current user.

Available since 2023.1

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | name |  String  |  The name of the tag to add to the article.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [Tag](v1-Tag.html)  |  The tag that has been added to the article.                 |

Example
: ```JAVASCRIPT
: article.addTag('review');
: ```

### becomes

```JAVASCRIPT
becomes(fieldName, expected)
```

Checks whether a field is set to an expected value in the current transaction.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | expected |  string  |  The expected value.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the field is set to the expected value, returns `true`.                 |

### canBeReadBy

```JAVASCRIPT
canBeReadBy(fieldName, user)
```

Checks whether a user has permission to read the field.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field.                     |
: | user |  [User](v1-User.html)  |  The user for whom the permission to read the field is checked.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the user can read the field, returns `true`.                 |

### canBeWrittenBy

```JAVASCRIPT
canBeWrittenBy(fieldName, user)
```

Checks whether a user has permission to update the field.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field.                     |
: | user |  [User](v1-User.html)  |  The user for whom the permission to update the field is checked.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the user can update the field, returns `true`.                 |

### hasTag

```JAVASCRIPT
hasTag(tagName)
```

Checks whether the specified tag is attached to the article.

Available since 2023.1

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | tagName |  String  |  The name of the tag to check for the article.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  Boolean  |  If the specified tag is attached to the article, returns `true`.                 |

### is

```JAVASCRIPT
is(fieldName, expected)
```

Checks whether a field is equal to an expected value.

Available since 2019.2.55603

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | expected |  string  |  The expected value.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the field is equal to the expected value, returns `true`.                 |

### isChanged

```JAVASCRIPT
isChanged(fieldName)
```

Checks whether the value of a field is changed in the current transaction.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the value of the field is changed in the current transaction, returns `true`.                 |

### oldValue

```JAVASCRIPT
oldValue(fieldName)
```

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, returns `null`.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  Object  |  If the field is changed in the current transaction, the previous value of the field. Otherwise, `null`.                 |

### removeTag

```JAVASCRIPT
removeTag(name)
```

Removes a tag with the specified name from an article. If the specified tag is not attached to the article, nothing happens. This method first searches through tags owned by the current user, then through all other visible tags.

Available since 2023.1

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | name |  String  |  The name of the tag to remove from the article.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  [Tag](v1-Tag.html)  |  The tag that has been removed from the article.                 |

Example
: ```JAVASCRIPT
: article.removeTag('waiting for review');
: ```

### required

```JAVASCRIPT
required(fieldName, message)
```

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | message |  string  |  The message that is displayed to the user that describes the field requirement.                     |

### was

```JAVASCRIPT
was(fieldName, expected)
```

Checks whether a field was equal to an expected value prior to the current transaction.

Available since 2019.2.55603

Parameters
: | Name | Type | Description |
: | --- | --- | --- |
: | fieldName |  string  |  The name of the field to check.                     |
: | expected |  string  |  The expected value.                     |

Return Value
: | Type | Description |
: | --- | --- |
: |  boolean  |  If the field was equal to the expected value, returns `true`.                 |

## See also

[BaseArticle](v1-BaseArticle.html) [Set](v1-Set.html) [BaseArticleAttachment](v1-BaseArticleAttachment.html) [User](v1-User.html) [ArticleComment](v1-ArticleComment.html) [Extension Properties](apps-extension-properties.html)