BaseWorkItem
The base class for issue work items.
Extends BaseEntity.
Properties
Name | Type | Description |
|---|---|---|
author | User | Read-only. The user to whom the work is attributed in the work item. |
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} |
created | Number | Read-only. The date when the work item was created. |
creator | User | Read-only. The user who added the work item to the issue. |
description | String | The work item description. |
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 |
type | WorkItemType | The work item type. Writable since 2020.2 |
updated | Number | Read-only. The date when the work item was last updated. |
Methods
canBeReadBy
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
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`. |
is
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`. |
required
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. |