IssueWorkItem
Represents a work item that has been added to an issue.
Extends BaseWorkItem.
Properties
Name | Type | Description |
---|---|---|
attributes | WorkItemAttributes | Read-only. Custom work item attributes. Available since 2024.2 |
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. |
date | Number | Read-only. The date and time that is assigned to the work item. Stored as a Unix timestamp in UTC. The time part is set to midnight for the current date. |
description | String | The work item description. |
duration | Number | The duration of the work item in minutes. Writable since 2018.1.40800 |
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
findByExtensionProperties
Searches IssueWorkItem by the extension properties query.
Available since 2024.3.43260
Parameters
Name | Type | Description |
---|---|---|
extensionPropertiesQuery | Object | The extension properties query. |
Return Value
Type | Description |
---|---|
Set.<IssueWorkItem> | The set of IssueWorkItem entities found by the extension properties query. |
Example
becomes
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
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`. |
delete
Permanently deletes the work item.
Available since 2018.2.42312
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`. |
isChanged
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
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. |
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. |
was
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`. |