# Sprint Represents a sprint that is associated with an agile board. Each sprint can include issues from one or more projects. Extends [BaseEntity](v1-BaseEntity.html). ## Properties | Name | Type | Description | | --- | --- | --- | | agile | [Agile](v1-Agile.html) | Read-only.  The agile board that the sprint belongs to. | | 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} ``` | | 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()); } }); ``` | | finish | Number | Read-only.  The end date of the sprint. | | isArchived | Boolean | Read-only.  If the sprint is currently archived, this property is `true`. | | 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 sprint. | | start | Number | Read-only.  The start date of the sprint. | ## Methods ### findByExtensionProperties ```JAVASCRIPT static findByExtensionProperties(extensionPropertiesQuery) ``` Searches for Sprint 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).<[Sprint]()> | The set of Sprint entities that contain the specified extension properties. | Example : ```JAVASCRIPT : { : property1: "value1", : property2: "value2" : } : ``` ### addIssue ```JAVASCRIPT addIssue(issue) ``` Adds the issue to the sprint. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue that is added to the sprint. | ### 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`. | ### containsIssue ```JAVASCRIPT containsIssue(issue) ``` Checks whether the issue belongs to the sprint. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue for which the condition is checked. | Return Value : | Type | Description | : | --- | --- | : | Boolean | If the issue belongs to the sprint, 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`. | ### isSwimlane ```JAVASCRIPT isSwimlane(issue) ``` Checks whether the specified issue is represented as a swimlane on the agile board that the sprint belongs to. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue to check. | Return Value : | Type | Description | : | --- | --- | : | Boolean | If the specified issue is represented as a swimlane in the sprint, 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`. | ### removeIssue ```JAVASCRIPT removeIssue(issue) ``` Removes the issue from the sprint. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue that is removed from the sprint. | ### 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 [BaseEntity](v1-BaseEntity.html) [Agile](v1-Agile.html) [Extension Properties](apps-extension-properties.html) [Set](v1-Set.html) [Issue](v1-Issue.html) [User](v1-User.html)