Agile

Represents an agile board and the set of sprints that belong to the board.

Properties

Name	Type	Description
author	User	Read-only. The user who created the board.
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}
currentSprint	Sprint	Read-only. The sprint that is considered to be in active development at the current moment. Available since 2023.1
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 https://www.jetbrains.com.cn/en-us/help/youtrack/devportal/apps-extension-properties.html. Available since 2024.3 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()); } });
isNew	Boolean	Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351
name	String	Read-only. The name of the agile board.
sprints	Set.<Sprint>	Read-only. The set of sprints that are associated with the board.

Methods

findByExtensionProperties

static findByExtensionProperties(extensionPropertiesQuery)

Searches for Agile 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.<Agile>	The set of Agile entities that contain the specified extension properties.

Example

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

findByName

static findByName(name)

Returns a set of agile boards that have the specified name.

Parameters

Name	Type	Description
name	String	The name of an agile board.

Return Value

Type	Description
Set.<Agile>	A set of agile boards that are assigned the specified name.

addIssue

addIssue(issue)

Adds the issue to the current sprint of the board.

Parameters

Name	Type	Description
issue	Issue	The issue that is added to the board.

becomes

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

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	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

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	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`.

containsIssue

containsIssue(issue)

Checks whether the issue belongs to the board.

Parameters

Name	Type	Description
issue	Issue	The issue for which the condition is checked.

Return Value

Type	Description
Boolean	If the issue belongs to the board, returns ``true``.

findSprintByName

findSprintByName(name)

Finds a specific sprint by name.

Parameters

Name	Type	Description
name	String	The name of the sprint.

Return Value

Type	Description
Sprint	If a sprint with the specified name is found, the corresponding Sprint object is returned. Otherwise, the return value is null.

getAddedSprints

getAddedSprints(issue)

Gets all sprints of this board where the issue is added during the current transaction.

Parameters

Name	Type	Description
issue	Issue	The issue for which added sprints are returned.

Return Value

Type	Description
Set.<Sprint>	A set of sprints where the issue is added.

getIssueSprints

getIssueSprints(issue)

Returns the sprints that an issue is assigned to on an agile board.

Available since 2018.1.39547

Parameters

Name	Type	Description
issue	Issue	The issue for which you want to get the sprints that it is assigned to.

Return Value

Type	Description
Set.<Sprint>	The sprints that the issue is assigned to on the agile board.

getRemovedSprints

getRemovedSprints(issue)

Gets all sprints of this board from which the issue is removed during the current transaction.

Parameters

Name	Type	Description
issue	Issue	The issue for which removed sprints are returned.

Return Value

Type	Description
Set.<Sprint>	A set of sprints from which the issue is removed.

getSprints

getSprints(issue)

Gets all sprints of this board where the issue belongs.

Parameters

Name	Type	Description
issue	Issue	The issue for which sprints are returned.

Return Value

Type	Description
Set.<Sprint>	A set of sprints where the issue belongs.

is

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`.

isAdded

isAdded(issue)

Checks whether the issue gets added to the board in the current transaction.

Parameters

Name	Type	Description
issue	Issue	The issue for which the condition is checked.

Return Value

Type	Description
Boolean	If the issue gets added to the board, returns ``true``.

isChanged

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`.

isRemoved

isRemoved(issue)

Checks whether the issue gets removed from the board in the current transaction.

Parameters

Name	Type	Description
issue	Issue	The issue for which the condition is checked.

Return Value

Type	Description
Boolean	If the issue gets removed from the board, returns ``true``.

oldValue

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.

removeIssue

removeIssue(issue)

Removes the issue from all sprints of this board where it belongs.

Parameters

Name	Type	Description
issue	Issue	The issue that is removed from the board.

required

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

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`.

22 November 2025