Article

Last modified: 11 March 2025

Properties

Name	Type	Description
attachments	Set.<BaseArticleAttachment>	Read-only. The set of attachments that are attached to the article.
author	User	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 `runOn: {removal: true}`
childArticles	Set.<Article>	The set of sub-articles of the current one. Available since 2024.4
comments	Set.<ArticleComment>	Read-only. A list of comments for the article.
content	String	The text that is entered as the article content.
created	Number	Read-only. The date when the article was created.
editedComments	Set.<ArticleComment>	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.
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 'Star' tag to watch the article, this property is `true`. Available since 2023.1
numberInProject	Number	Read-only. The article number in the project.
parentArticle	Article	The parent article of the current one. Available since 2024.4
pinnedComments	Set.<ArticleComment>	Read-only. The set of comments that are pinned in the article. Available since 2024.1
project	Project	The project to which the article is assigned.
summary	String	The article title.
tags	Set.<Tag>	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	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

Article(author, project, summary)

Name	Type	Description
author	User, JsonForArticleConstructor	The author of the article. Alternatively, pass a JSON specified by JsonForArticleConstructor
project	Project	The project where the new article is created.
summary	String	The article title.

Methods

action

static action(ruleProperties, ruleProperties.title, ruleProperties.userInput, ruleProperties.userInput.type, ruleProperties.userInput.description, ruleProperties.guard, ruleProperties.action, ruleProperties.requirements)

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

Type	Description
Object	The object representation of the rule.

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

findByExtensionProperties

static findByExtensionProperties(extensionPropertiesQuery)

Name	Type	Description
extensionPropertiesQuery	Object	The extension properties query.

Type	Description
Set.<Article>	The set of Article entities found by the extension properties query.

{
   property1: "value1",
   property2: "value2"
}

findById

static findById(id)

Name	Type	Description
id	String	The article ID.

Type	Description
Article	The article that is assigned the specified ID.

onChange

static onChange(ruleProperties, ruleProperties.title, ruleProperties.guard, ruleProperties.action, ruleProperties.requirements, ruleProperties.runOn, ruleProperties.runOn.change, ruleProperties.runOn.removal)

Name	Type	Description
ruleProperties	Object	A JSON object that defines the properties for the rule.
ruleProperties.title	string	The human-readable name of the rule. Displayed in the administrative UI in YouTrack.
ruleProperties.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.
ruleProperties.action	Article~actionFunction	The function that is invoked on an article change.
ruleProperties.requirements	Requirements	The set of entities that must be present for the script to work as expected.
ruleProperties.runOn	Object	Determines which article events trigger the on-change rule. When not specified, the rule is triggered on an article change.
ruleProperties.runOn.change	boolean	When `true`, the rule is triggered on an article change.
ruleProperties.runOn.removal	boolean	When `true`, the rule is triggered when an article is logically deleted.

Type	Description
Object	The object representation of the rule.

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);
  }
});

addComment

addComment(text, author)

Name	Type	Description
text	String, JsonForArticleAddComment	The text to add to the article as a comment. Alternatively, pass a JSON specified by JsonForArticleAddComment
author	User	The author of the comment.

Type	Description
ArticleComment	A newly created comment.

addTag

addTag(name)

Name	Type	Description
name	String	The name of the tag to add to the article.

Type	Description
Tag	The tag that has been added to the article.

article.addTag('review');

becomes

becomes(fieldName, expected)

Type	Description
boolean	If the field is set to the expected value, returns `true`.

canBeReadBy

canBeReadBy(fieldName, user)

Name	Type	Description
fieldName	string	The name of the field.
user	User	The user for whom the permission to read the field is checked.

Type	Description
boolean	If the user can read the field, returns `true`.

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Name	Type	Description
fieldName	string	The name of the field.
user	User	The user for whom the permission to update the field is checked.

Type	Description
boolean	If the user can update the field, returns `true`.

hasTag

hasTag(tagName)

Name	Type	Description
tagName	String	The name of the tag to check for the article.

Type	Description
Boolean	If the specified tag is attached to the article, returns `true`.

is

is(fieldName, expected)

Type	Description
boolean	If the field is equal to the expected value, returns `true`.

isChanged

isChanged(fieldName)

Type	Description
boolean	If the value of the field is changed in the current transaction, returns `true`.

oldValue

oldValue(fieldName)

Type	Description
Object	If the field is changed in the current transaction, the previous value of the field. Otherwise, null.

removeTag

removeTag(name)

Name	Type	Description
name	String	The name of the tag to remove from the article.

Type	Description
Tag	The tag that has been removed from the article.

article.removeTag('waiting for review');

required

required(fieldName, message)

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

was(fieldName, expected)

Article﻿

Properties﻿

Constructors﻿

Article﻿

Methods﻿

action﻿

findByExtensionProperties﻿

findById﻿

onChange﻿

addComment﻿

addTag﻿

becomes﻿

canBeReadBy﻿

canBeWrittenBy﻿

hasTag﻿

is﻿

isChanged﻿

oldValue﻿

removeTag﻿

required﻿

was﻿

Article

Properties

Constructors

Article

Methods

action

findByExtensionProperties

findById

onChange

addComment

addTag

becomes

canBeReadBy

canBeWrittenBy

hasTag

is

isChanged

oldValue

removeTag

required

was