YouTrack Standalone 2019.2 Help

IssueWorkItem

Represents a work item that has been added to an issue.

Extends BaseWorkItem.

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

Available since 2017.4.37915

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

isUsingMarkdown

Boolean When `true`, the work item description is parsed as Markdown. When `false`, the work item description is parsed as YouTrack Wiki. Changing this value does not transform the markup from one syntax to another.

Available since 2017.4.38870

type

WorkItemType

Read-only. The work item type.

updated

Number

Read-only. The date when the work item was last updated.

Methods


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

 

delete

delete()

Permanently deletes the work item.

Available since 2018.2.42312

 

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

 

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.

 

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.

 

Last modified: 22 October 2019