---
schema: rendered-html/v1
title: "Issue | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/v1-Issue.html
generated_at: 2026-06-11T15:16:55.295831+00:00
---






- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- JavaScript Workflow Quick Start Guide
- Create a Workflow
- Edit a Workflow
- Workflow Rule Types
- Transactions
- Use Cases for Workflows
- Web-based Workflow Editor
- Using an External Code Editor
- Default Workflows
- Custom Workflow Repository
- JavaScript Workflow Reference
- Rule-specific Properties
- Context
- Requirements
- Using the Workflow API
- Building Integrations with Slack
- Using REST API Methods in JavaScript Workflows
- Working with Dates and Times
- Working with Periods
- Localized Workflow Messages
- Troubleshooting Workflows
- Remote Debugger
- YouTrack Workflow API
- Change Log
- date-time
- entities
- AbstractVcsItem
- Agile
- AppGlobalStorage
- Article
- ArticleAttachment
- ArticleComment
- BaseArticle
- BaseArticleAttachment
- BaseArticleComment
- BaseComment
- BaseEntity
- BaseWorkItem
- Build
- BundleElementCondition
- BundleProjectCustomField
- Calendar
- Calendar24x7
- ChangesProcessor
- Channel
- EnumField
- FeedbackForm
- Field
- FieldBasedBundleValuesCondition
- [FieldBasedUserValuesCondition](jetbrains__com__help__youtrack__devportal__v1-fieldbaseduservaluescondition.md)
- [FieldBasedValuesCondition](jetbrains__com__help__youtrack__devportal__v1-fieldbasedvaluescondition.md)
- [Fields](jetbrains__com__help__youtrack__devportal__v1-fields.md)
- [Gantt](jetbrains__com__help__youtrack__devportal__v1-gantt.md)
- [GroupProjectCustomField](jetbrains__com__help__youtrack__devportal__v1-groupprojectcustomfield.md)
- [Issue](v1-Issue.html)
- [IssueAttachment](jetbrains__com__help__youtrack__devportal__v1-issueattachment.md)
- [IssueComment](jetbrains__com__help__youtrack__devportal__v1-issuecomment.md)
- [IssueLinkPrototype](jetbrains__com__help__youtrack__devportal__v1-issuelinkprototype.md)
- [IssueTag](jetbrains__com__help__youtrack__devportal__v1-issuetag.md)
- [IssueWorkItem](jetbrains__com__help__youtrack__devportal__v1-issueworkitem.md)
- [Iterator](jetbrains__com__help__youtrack__devportal__v1-iterator.md)
- JsonForArticleAddAttachment
- JsonForArticleAddComment
- JsonForArticleConstructor
- JsonForIssueAddAttachment
- JsonForIssueAddComment
- JsonForIssueAddWorkItem
- JsonForIssueCommentAddAttachment
- JsonForIssueConstructor
- JsonForUserNotify
- MailboxChannel
- OwnedField
- PeriodProjectCustomField
- PersistentFile
- Project
- ProjectCustomField
- ProjectTeam
- ProjectType
- ProjectVersion
- PullRequest
- PullRequestState
- Requirement
- Requirements
- SavedQuery
- Set
- SimpleCalendar
- SimpleProjectCustomField
- Sprint
- State
- Tag
- TextProjectCustomField
- User
- UserAttributes
- UserCondition
- UserGroup
- UserProjectCustomField
- UserType
- VcsChange
- VcsServer
- WatchFolder
- WorkItemAttributeValue
- WorkItemAttributes
- WorkItemProjectAttribute
- WorkItemType
- http
- license
- notifications
- search
- strings
- workflow
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Hub REST API

1. YouTrack Workflows
2. JavaScript Workflow Reference
3. YouTrack Workflow API
4. entities
5. [Issue](#0)

# Issue﻿

Last modified: 14 May 2026

Represents an issue in YouTrack.

Extends BaseEntity.

## Properties﻿

| --- | --- | --- |
| attachments | Set.<IssueAttachment> | Read-only.   The set of attachments that are attached to the issue. |
| 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} ``` |
| becomesReported | Boolean | Read-only.   If the issue becomes reported in the current transaction, this property is `true`.  ``` if (issue.fields.Subsystem !== null && issue.fields.Assignee === null &&     (((issue.isChanged('Subsystem') || issue.isChanged('project') && issue.isReported) ||         issue.becomesReported) {     issue.fields.Assignee = issue.fields.Subsystem.owner } ``` |
| becomesResolved | Boolean | Read-only.   If the issue was previously unresolved and is assigned a state that is considered resolved in the current transaction, this property is `true`. |
| becomesUnresolved | Boolean | Read-only.   If the issue was previously resolved and is assigned a state that is considered unresolved in the current transaction, this property is `true`. |
| ccUsers | Set.<User> | The users added as CCs to the helpdesk ticket. The ticket reporter is excluded automatically. Up to 10 reporter-type users can be kept in CC; extra reporters are removed automatically.    Available since 2026.1 |
| channel | Channel | Read-only.   The channel used by the reporter to create the ticket. Possible values are 'FeedbackForm' for online forms or 'MailboxChannel' for email. |
| comments | Set.<IssueComment> | Read-only.   A list of comments for the issue. |
| created | Number | Read-only.   The date when the issue was created. |
| description | String | The text that is entered as the issue description. |
| draftId | String | Read-only.   Draft issue ID. Returns `null` if the issue is not a draft.    Available since 2025.3 |
| duplicateRoot | Issue | Read-only.   The root issue in a tree of duplicates that are linked to the issue. For example, if `issueA` duplicates `issueB` and `issueB` duplicates `issueC`, then the value for the `issueA.duplicateRoot()` property is `issueC`. |
| editedComments | Set.<IssueComment> | Read-only.   The set of comments that are edited in the current transaction. Comments that are added and removed are not considered to be edited. Instead, these are represented by the `issue.comments.added` and `issue.comments.removed` properties. |
| editedWorkItems | Set.<IssueWorkItem> | Read-only.   The set of work items that are edited in the current transaction. Work items that are added and removed are not considered to be edited. Instead, these are represented by the `issue.workItems.added` and `issue.workItems.removed` properties.    Available since 2017.4.37824 |
| 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/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());     } }); ``` |
| fields | Fields | The custom fields that are used in an issue. This is the collection of issue attributes like `Assignee`, `State`, and `Priority` that are defined in the Custom Fields section of the administrative interface and can be attached to each project independently. Issue attributes like `reporter`, `numberInProject`, and `project` are accessed directly.  ``` if (issue.fields.becomes(ctx.Priority, ctx.Priority.Critical) {   issue.fields.Assignee = issue.project.leader; } ``` |
| ganttCharts | Set.<Gantt> | Read-only.   The collection of Gantt charts that this issue has been added to.    Available since 2022.1 |
| id | String | Read-only.   The issue ID.  ``` user.notify('Issue is overdue', 'Please, look at the issue: ' + issue.id); ``` |
| isNew | Boolean | Read-only.   When `true`, the entity is created in the current transaction. Otherwise, `false`.    Available since 2018.2.42351 |
| isReported | Boolean | Read-only.   If the issue is already reported or becomes reported in the current transaction, this property is `true`. To apply changes to an issue draft, use `!issue.isReported`.  ``` issue.links['depends on'].forEach(function(dep) {   if (dep.isReported) {     assert(dep.State.resolved, 'The issue has unresolved dependencies and thus cannot be set Fixed!');   } }); ``` |
| isResolved | Boolean | Read-only.   If the issue is currently assigned a state that is considered resolved, this property is `true`. |
| isStarred | Boolean | Read-only.   If the current user has added the 'Star' tag to watch the issue, this property is `true`. |
| links | Object | Issue links (e.g. `relates to`, `parent for`, etc.). Each link is a Set of Issue objects.  ``` if (issue.links['parent for'].added.isNotEmpty()) {   issue.links['parent for'].added.forEach(function(subtask) {     subtask.fields.Priority = issue.fields.Priority;   }); } ``` |
| mentionedInIssueComments | Set.<IssueComment> | Read-only.   The set of issue comments where this issue is mentioned. |
| mentionedInIssues | Set.<Issue> | Read-only.   The set of issues where this issue is mentioned. |
| numberInProject | Number | Read-only.   The issue number in the project. |
| permittedGroup | UserGroup | The user group for which the issue is visible. If the property contains a null value, the issue is visible to the All Users group. |
| permittedGroups | Set.<UserGroup> | The groups for which the issue is visible when the visibility is restricted to multiple groups. |
| permittedUsers | Set.<User> | The list of users for whom the issue is visible. |
| pinnedComments | Set.<IssueComment> | Read-only.   The set of comments that are pinned in the issue.    Available since 2024.1 |
| project | Project | The project to which the issue is assigned. |
| pullRequests | Set.<PullRequest> | Read-only.   The list of pull requests that are associated with the issue.    Available since 2020.3 |
| reporter | User | Read-only.   The user who reported (created) the issue.  ``` issue.fields.Assignee = issue.reporter; ``` |
| resolved | Number | Read-only.   The date and time when the issue was assigned a state that is considered to be resolved. |
| summary | String | The text that is entered as the issue summary. |
| tags | Set.<Tag> | The list of tags that are attached to an issue. |
| unauthenticatedReporter | Boolean | Read-only.   When true, the ticket was created by a reporter who was not logged in to YouTrack when they submitted the support request. |
| updated | Number | Read-only.   The date when the issue was last updated. |
| updatedBy | User | Read-only.   The user who last updated the issue. |
| url | String | Read-only.   The absolute URL that points to the issue.  ``` user.notify('Issue is overdue', 'Please, look at the issue: ' + issue.url); ``` |
| vcsChanges | Set.<VcsChange> | Read-only.   The list of commits that are associated with the issue.    Available since 2018.1.38923 |
| voters | Set.<User> | Read-only.   Users who voted for the issue.    Available since 2020.5 |
| votes | Number | Read-only.   The number of votes for an issue. For vote-related methods, see User.canVoteIssue, User.voteIssue, User.canUnvoteIssue, and User.unvoteIssue. |
| watchers | Set.<User> | Read-only.   Returns the watchers of the issue.    Available since 2025.3 |
| workItems | Set.<IssueWorkItem> | Read-only.   The set of work items that have been added to the issue. |

## Constructors﻿

### Issue﻿

Issue(reporter, project, summary)


| --- | --- | --- |
| reporter | User, JsonForIssueConstructor | Issue reporter. Alternatively, pass a JSON specified by JsonForIssueConstructor |
| project | Project | Project that the new issue is to belong to. |
| summary | String | Issue summary. |

## Methods﻿

### action﻿

static action(ruleProperties, ruleProperties.title, ruleProperties.command, ruleProperties.userInput, ruleProperties.userInput.type, ruleProperties.userInput.description, ruleProperties.guard, ruleProperties.action, ruleProperties.requirements)

Creates a declaration of a rule that a user can apply to one or more issues with a command or menu option. The object that is returned by this method is normally exported to the `rule` property, otherwise it is not treated as a rule.


| --- | --- | --- |
| ruleProperties | Object | A JSON object that defines the properties for the rule. |
| ruleProperties.title | string | The human-readable name of the rule. Displayed in the administrative UI in YouTrack. |
| ruleProperties.command | string | The custom command that triggers the action. |
| ruleProperties.userInput | Object | An object that defines the properties for information that will be requested from the user who triggers the action rule. |
| ruleProperties.userInput.type | string, Object | The data type for the value that is requested from the user. The following types are supported: \* entities.Field.dateTimeType \* entities.Field.dateType \* entities.Field.integerType \* entities.Field.floatType \* entities.Field.periodType \* entities.Field.stringType \* entities.Build \* entities.EnumField \* entities.Issue \* entities.IssueTag \* entities.OwnedField \* entities.Project \* entities.ProjectVersion \* entities.UserGroup \* entities.User |
| ruleProperties.userInput.description | string | The label for the control that is used to collect additional information from the user. |
| ruleProperties.guard | Issue~guardFunction | A function that is invoked to determine whether the action is applicable to an issue. |
| ruleProperties.action | Issue~actionFunction | The function that is invoked when a user triggers this action. |
| ruleProperties.requirements | Requirements | The set of entities that must be present for the script to work as expected. |

**Return Value**

| --- | --- |
| Object | The object representation of the rule. |

**Example**

var entities = require('@jetbrains/youtrack-scripting-api/entities');
exports.rule = entities.Issue.action({
  title: 'Log comments',
  command: 'log',
  guard: function(ctx) {
    return ctx.issue.isReported;
  },
  action: function(ctx) {
    ctx.issue.comments.forEach(function(comment) {
      console.log(comment.text);
    });
  }
});

### createDraft﻿

static createDraft(project, reporter)

Creates a new issue draft.

Available since 2025.1


| --- | --- | --- |
| project | Project | Project that the new issue draft is to belong to. |
| reporter | User | Issue draft reporter. |

**Return Value**

| --- | --- |
| Issue | Newly created issue draft. |

### createSharedDraft﻿

static createSharedDraft(project)

Creates a new shared issue draft.

Available since 2025.1


| --- | --- | --- |
| project | Project | Project that the new issue draft is to belong to. |

**Return Value**

| --- | --- |
| Issue | Newly created issue draft. |

### findByExtensionProperties﻿

static findByExtensionProperties(extensionPropertiesQuery)

Searches for Issue entities with extension properties that match the specified query.

Available since 2024.3.43260


| --- | --- | --- |
| extensionPropertiesQuery | Object | The extension properties query, defined as a set of key-value pairs representing properties and their corresponding values. |

**Return Value**

| --- | --- |
| Set.<Issue> | The set of Issue entities that contain the specified extension properties. |

**Example**

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

### findById﻿

static findById(id)

Finds an issue by its visible ID.


| --- | --- | --- |
| id | String | The issue ID. |

**Return Value**

| --- | --- |
| Issue | The issue that is assigned the specified ID. |

**Example**

var myIssue = entities.Issue.findById("NP-15971");

### onChange﻿

static onChange(ruleProperties, ruleProperties.title, ruleProperties.guard, ruleProperties.action, ruleProperties.requirements, ruleProperties.runOn, ruleProperties.runOn.change, ruleProperties.runOn.removal)

Creates a declaration of a rule that is triggered when a change is applied to an issue. The object that is returned by this method is normally exported to the `rule` property, otherwise it is not treated as a rule.


| --- | --- | --- |
| ruleProperties | Object | A JSON object that defines the properties for the rule. |
| ruleProperties.title | string | The human-readable name of the rule. Displayed in the administrative UI in YouTrack. |
| ruleProperties.guard | Issue~guardFunction | A function that determines the conditions for executing the rule. If the guard condition is not met, the action specified in the rule is not applied to the issue. |
| ruleProperties.action | Issue~actionFunction | The function that is invoked on an issue change. |
| ruleProperties.requirements | Requirements | The set of entities that must be present for the script to work as expected. |
| ruleProperties.runOn | Object | Determines which issue events trigger the on-change rule. When not specified, the rule is triggered on an issue change. |
| ruleProperties.runOn.change | boolean | When `true`, the rule is triggered on an issue change. |
| ruleProperties.runOn.removal | boolean | When `true`, the rule is triggered when an issue is logically deleted. |

**Return Value**

| --- | --- |
| Object | The object representation of the rule. |

**Example**

var entities = require('@jetbrains/youtrack-scripting-api/entities');
exports.rule = entities.Issue.onChange({
  title: 'On issue change, log its ID',
  action: function(ctx) {
    console.log(ctx.issue.id);
  }
});

### onSchedule﻿

static onSchedule(ruleProperties, ruleProperties.title, ruleProperties.search, ruleProperties.cron, ruleProperties.muteUpdateNotifications, ruleProperties.modifyUpdatedProperties, ruleProperties.action, ruleProperties.requirements)

Creates a declaration of a rule that is triggered on a set schedule. The object that is returned by this method is normally exported to the `rule` property, otherwise it is not treated as a rule.


| --- | --- | --- |
| ruleProperties | Object | A JSON object that defines the properties for the rule. |
| ruleProperties.title | string | The human-readable name of the rule. Displayed in the administrative UI in YouTrack. |
| ruleProperties.search | string, function | A YouTrack search string or a function with no parameters that returns such a string. The specified action is applied to all issues that match the search and belong to the project that this rule is attached to. |
| ruleProperties.cron | string | A cron expression that specifies the interval for applying the rule. |
| ruleProperties.muteUpdateNotifications | boolean | `true` if no notifications should be sent on changes made by this rule or any rule that reacted on a change made by this rule. |
| ruleProperties.modifyUpdatedProperties | boolean | When `true`, updates applied by the workflow rule are reflected in the `updated` and `updatedBy` properties of the target entity. Otherwise, the values for these properties remain unchanged. |
| ruleProperties.action | Issue~actionFunction | The function that is invoked on schedule for each issue that matches the search. |
| ruleProperties.requirements | Requirements | The set of entities that must be present for the script to work as expected. |

**Return Value**

| --- | --- |
| Object | The object representation of the rule. |

**Example**

var entities = require('@jetbrains/youtrack-scripting-api/entities');
exports.rule = entities.Issue.onSchedule({
  title: 'Log IDs of major issues every 5 seconds',
  search: '#Major',
  cron: '0/5 * * * * ?',
  action: function(ctx) {
    console.log(ctx.issue.id);
  }
});

### sla﻿

static sla(ruleProperties, ruleProperties.title, ruleProperties.guard, ruleProperties.onEnter, ruleProperties.action, ruleProperties.onBreach, ruleProperties.requirements)

Creates a declaration of a custom SLA policy. An SLA policy defines the time goals for the replies from staff and request resolution.


| --- | --- | --- |
| ruleProperties | Object | A JSON object that defines the properties for the SLA policy. |
| ruleProperties.title | string | The human-readable name of the SLA policy. Displayed in the administrative UI in YouTrack. |
| ruleProperties.guard | Issue~slaGuardFunction | A function that is invoked to determine whether the policy is applicable to the ticket. |
| ruleProperties.onEnter | Issue~slaEnterFunction | A function that is invoked when the SLA policy starts applying to the ticket. |
| ruleProperties.action | Issue~slaActionFunction | The function that is invoked when the policy needs to update the ticket. For example, it might pause the timers according to the SLA settings. |
| ruleProperties.onBreach | Issue~slaBreachFunction | A function that is invoked when one of the SLA goals is breached. The name of the field that caused the breach is stored in the ctx.breachedField parameter. |
| ruleProperties.requirements | Requirements | The set of entities that must be present for the script to work as expected. When you define a custom field of date and time type in the requirements, YouTrack handles this field as an SLA timer. |

**Return Value**

| --- | --- |
| Object | The object representation of the SLA policy. |

**Example**

const entities = require('@jetbrains/youtrack-scripting-api/entities');
exports.rule = entities.Issue.sla({
  title: "Support",
  guard: (ctx) => {
    return false;
  },
  onEnter: (ctx) => {
    console.log('onEnter', ctx.issue.id);
  },
  action: (ctx) => {
    console.log('action', ctx.issue.id);
  },
  onBreach: (ctx) => {
    console.log('onBreach', ctx.issue.id, ctx.breachedField);
  },

  requirements: {
    firstReplyField: {
      type: entities.Field.dateTimeType,
      name: 'First Reply'
    },
    state: {
      type: entities.State.fieldType,
      name: 'State'
    }
  }
});

### stateMachine﻿

static stateMachine(ruleProperties, ruleProperties.title, ruleProperties.fieldName, ruleProperties.stateFieldName, ruleProperties.states, ruleProperties.defaultMachine, ruleProperties.typeFieldName, ruleProperties.alternativeMachines, ruleProperties.requirements)

Creates a declaration of a state-machine rule. The state-machine imposes restrictions for the transitions between values in a custom field. You can execute actions when the custom field is set to a value, changes from a value, or transitions from two specific values. The object that is returned by this method is normally exported to the `rule` property, otherwise it is not treated as a rule.


| --- | --- | --- |
| ruleProperties | Object | A JSON object that defines the properties for the rule. |
| ruleProperties.title | string | The human-readable name of the rule. Displayed in the administrative UI in YouTrack. |
| ruleProperties.fieldName | string | The name of a field that is managed by the state-machine rule. Declare either fieldName or stateFieldName, not both. |
| ruleProperties.stateFieldName | string | An alias for ruleProperties.fieldName for building state-machines per issue type. When both stateFieldName and fieldName are declared, an exception is thrown. |
| ruleProperties.states | Object | A list of values for a custom field and the possible transitions between them. Declare either states or defaultStateMachine, not both. |
| ruleProperties.defaultMachine | Object | An alias for ruleProperties.states for building state-machines per issue type. When both defaultMachine and states are declared, an exception is thrown. |
| ruleProperties.typeFieldName | string | The name of a field that defines which state-machine applies to the managed field. |
| ruleProperties.alternativeMachines | Object | An object that contains the definitions for one or more state-machines that apply to different types of issues. Object keys are the possible values of the field that is defined by the ruleProperties.typeFieldName. Object values have the same structure that is shown for 'states' in the example. This parameter is mandatory when the ruleProperties.typeFieldName parameter is specified. |
| ruleProperties.requirements | Requirements | The set of entities that must be present for the script to work as expected. |

**Return Value**

| --- | --- |
| Object | The object representation of the rule. |

**Example**

var entities = require('@jetbrains/youtrack-scripting-api/entities');
exports.rule = entities.Issue.stateMachine({
  title: 'Status state machine',
  fieldName: 'Status',
  states: {
    Open: {
      initial: true,
      transitions: {
        start: {
          targetState: 'In progress'
        }
      }
    },
    'In progress': {
      onEnter: function(ctx) {
        ctx.issue.fields.Assignee = ctx.currentUser;
      },
      transitions: {
        fix: {
          targetState: 'Fixed'
        },
        reopen: {
          targetState: 'Open'
        }
      }
    },
    Fixed: {
      transitions: {
      }
    }
  },
  requirements: {
    Assignee: {
      type: entities.User.fieldType
    }
  }
});

### addAttachment﻿

addAttachment(content, name, charset, mimeType)

Attaches a file to the issue. Makes `issue.attachments.isChanged` return `true` for the current transaction.

Available since 2019.2.53994


| --- | --- | --- |
| content | InputStream, String, JsonForIssueAddAttachment | The content of the file in binary form or as a base64 data URI. Base64 content must use the `data:[MIME type];base64,[content]` syntax. Alternatively, pass a JSON specified by JsonForIssueAddAttachment |
| name | String | The name of the file. |
| charset | String | The charset of the file. Only applicable to text files. |
| mimeType | String | The MIME type of the file. |

**Return Value**

| --- | --- |
| IssueAttachment | The attachment that is added to the issue. |

### addComment﻿

addComment(text, author)

Adds a comment to the issue. Makes `issue.comments.isChanged` return `true` for the current transaction.


| --- | --- | --- |
| text | String, JsonForIssueAddComment | The text to add to the issue as a comment. Alternatively, pass a JSON specified by JsonForIssueAddComment |
| author | User | The author of the comment. |

**Return Value**

| --- | --- |
| IssueComment | A newly created comment. |

### addTag﻿

addTag(name)

Adds a tag with the specified name to an issue. YouTrack adds the first matching tag that is visible to the current user. If a match is not found, a new private tag is created for the current user.


| --- | --- | --- |
| name | String | The name of the tag to add to the issue. |

**Return Value**

| --- | --- |
| Tag | The tag that has been added to the issue. |

### addWorkItem﻿

addWorkItem(description, date, author, duration, type)

Adds a work item to the issue.


| --- | --- | --- |
| description | String, JsonForIssueAddWorkItem | The description of the work item. Alternatively, pass a JSON specified by JsonForIssueAddWorkItem |
| date | Number | The date that is assigned to the work item. |
| author | User | The user who performed the work. |
| duration | Number | The work duration in minutes. |
| type | WorkItemType | The work item type. |

**Return Value**

| --- | --- |
| IssueWorkItem | The new work item. |

### afterMinutes﻿

afterMinutes(initialTime, minutes, calendar, considerPauses)

Adds the specified number of minutes to a specified starting point in time.

Available since 2023.1


| --- | --- | --- |
| initialTime | Number | A timestamp for the starting point in time. YouTrack adds the specified number of minutes to this point. |
| minutes | Number | The number of minutes to add to the starting point. |
| calendar | Calendar | The SLA settings for the business hours that should be considered when adding minutes to the starting point. If the result falls outside the business hours after adding specified minutes, the extra minutes get automatically transferred to the next business day. |
| considerPauses | Boolean | A switcher that determines whether to consider the effects of the 'pauseSLA' and 'resumeSLA' methods when adding specified minutes to the starting point. |

**Return Value**

| --- | --- |
| Number | A timestamp after adding the specified number of minutes. |

### applyCommand﻿

applyCommand(command, runAs)

Applies a command to the issue.


| --- | --- | --- |
| command | String | The command that is applied to the issue. |
| runAs | User | Specifies the user by which the command is applied. If this parameter is not set, the command is applied on behalf of the current user. |

### becomes﻿

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.


| --- | --- | --- |
| fieldName | string | The name of the field to check. |
| expected | string | The expected value. |

**Return Value**

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


| --- | --- | --- |
| fieldName | string | The name of the field. |
| user | User | The user for whom the permission to read the field is checked. |

**Return Value**

| --- | --- |
| boolean | If the user can read the field, returns `true`. |

### canBeWrittenBy﻿

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.


| --- | --- | --- |
| fieldName | string | The name of the field. |
| user | User | The user for whom the permission to update the field is checked. |

**Return Value**

| --- | --- |
| boolean | If the user can update the field, returns `true`. |

### clearAttachments﻿

clearAttachments()

Removes all of the attachments from the issue.

### copy﻿

copy(project)

Creates a copy of the issue.


| --- | --- | --- |
| project | Project | Project to create new issue in. Available since 2018.1.40575. |

**Return Value**

| --- | --- |
| Issue | The copy of the original issue. |

### hasTag﻿

hasTag(tagName, ignoreVisibilitySettings)

Checks whether the specified tag is attached to an issue.


| --- | --- | --- |
| tagName | String | The name of the tag to check for the issue. |
| ignoreVisibilitySettings | Boolean | When `true`, checks all matching tags without regard to their visibility settings. When `false` (default), checks only matching tags that are visible to the current user. |

**Return Value**

| --- | --- |
| Boolean | If the specified tag is attached to the issue, returns `true`. |

### is﻿

is(fieldName, expected)

Checks whether a field is equal to an expected value.

Available since 2019.2.55603


| --- | --- | --- |
| fieldName | string | The name of the field to check. |
| expected | string | The expected value. |

**Return Value**

| --- | --- |
| boolean | If the field is equal to the expected value, returns `true`. |

### isChanged﻿

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.


| --- | --- | --- |
| fieldName | string | The name of the field to check. |

**Return Value**

| --- | --- |
| boolean | If the value of the field is changed in the current transaction, returns `true`. |

### isVisibleTo﻿

isVisibleTo(user)

Checks whether the issue is accessible by specified user.


| --- | --- | --- |
| user | User | The user to check. |

**Return Value**

| --- | --- |
| Boolean | If the issue is accessible for the user, 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.


| --- | --- | --- |
| fieldName | string | The name of the field. |

**Return Value**

| --- | --- |
| Object | If the field is changed in the current transaction, the previous value of the field. Otherwise, null. |

### pauseSLA﻿

pauseSLA()

Pauses the timers for the current SLA applied to the issue.

Available since 2023.1

### removeTag﻿

removeTag(name)

Removes a tag with the specified name from an issue. If the specified tag is not attached to the issue, nothing happens. This method first searches through tags owned by the current user, then through all other visible tags.


| --- | --- | --- |
| name | String | The name of the tag to remove from the issue. |

**Return Value**

| --- | --- |
| Tag | The tag that has been removed from the issue. |

### renderMarkup﻿

renderMarkup(text)

Converts text in markdown to HTML. Use this method to send "pretty" notifications.


| --- | --- | --- |
| text | String | The string of text to convert to HTML. |

**Return Value**

| --- | --- |
| String | Rendered markdown |

**Example**

issue.Assignee.notify('Comment added:', issue.renderMarkup(comment.text));

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


| --- | --- | --- |
| fieldName | string | The name of the field to check. |
| message | string | The message that is displayed to the user that describes the field requirement. |

### resumeSLA﻿

resumeSLA()

Resumes the timers for the current SLA applied to the issue.

Available since 2023.1

### setDefaultFieldValues﻿

setDefaultFieldValues()

Sets the default custom field values for the issue. Applies only for empty fields.

Available since 2025.3

### tag﻿

tag(tag)

Applies the tag to the issue.

Available since 2025.3


| --- | --- | --- |
| tag | Tag | The tag object. |

### untag﻿

untag(tag)

Removes the tag from the issue.

Available since 2025.3


| --- | --- | --- |
| tag | Tag | The tag object. |

### was﻿

was(fieldName, expected)

Checks whether a field was equal to an expected value prior to the current transaction.

Available since 2019.2.55603


| --- | --- | --- |
| fieldName | string | The name of the field to check. |
| expected | string | The expected value. |

**Return Value**

| --- | --- |
| boolean | If the field was equal to the expected value, returns `true`. |

- [Issue](/help/youtrack/devportal/v1-Issue.html)
- [Properties](/help/youtrack/devportal/v1-Issue.html#properties)
- [Constructors](/help/youtrack/devportal/v1-Issue.html#constructors)
- [Issue](/help/youtrack/devportal/v1-Issue.html#Issue)
- [Methods](/help/youtrack/devportal/v1-Issue.html#methods)
- [action](/help/youtrack/devportal/v1-Issue.html#action)
- [createDraft](/help/youtrack/devportal/v1-Issue.html#createDraft)
- [createSharedDraft](/help/youtrack/devportal/v1-Issue.html#createSharedDraft)
- [findByExtensionProperties](/help/youtrack/devportal/v1-Issue.html#findByExtensionProperties)
- [findById](/help/youtrack/devportal/v1-Issue.html#findById)
- [onChange](/help/youtrack/devportal/v1-Issue.html#onChange)
- [onSchedule](/help/youtrack/devportal/v1-Issue.html#onSchedule)
- [sla](/help/youtrack/devportal/v1-Issue.html#sla)
- [stateMachine](/help/youtrack/devportal/v1-Issue.html#stateMachine)
- [addAttachment](/help/youtrack/devportal/v1-Issue.html#addAttachment)
- [addComment](/help/youtrack/devportal/v1-Issue.html#addComment)
- [addTag](/help/youtrack/devportal/v1-Issue.html#addTag)
- [addWorkItem](/help/youtrack/devportal/v1-Issue.html#addWorkItem)
- [afterMinutes](/help/youtrack/devportal/v1-Issue.html#afterMinutes)
- [applyCommand](/help/youtrack/devportal/v1-Issue.html#applyCommand)
- [becomes](/help/youtrack/devportal/v1-Issue.html#becomes)
- [canBeReadBy](/help/youtrack/devportal/v1-Issue.html#canBeReadBy)
- [canBeWrittenBy](/help/youtrack/devportal/v1-Issue.html#canBeWrittenBy)
- [clearAttachments](/help/youtrack/devportal/v1-Issue.html#clearAttachments)
- [copy](/help/youtrack/devportal/v1-Issue.html#copy)
- [hasTag](/help/youtrack/devportal/v1-Issue.html#hasTag)
- [is](/help/youtrack/devportal/v1-Issue.html#is)
- [isChanged](/help/youtrack/devportal/v1-Issue.html#isChanged)
- [isVisibleTo](/help/youtrack/devportal/v1-Issue.html#isVisibleTo)
- [oldValue](/help/youtrack/devportal/v1-Issue.html#oldValue)
- [pauseSLA](/help/youtrack/devportal/v1-Issue.html#pauseSLA)
- [removeTag](/help/youtrack/devportal/v1-Issue.html#removeTag)
- [renderMarkup](/help/youtrack/devportal/v1-Issue.html#renderMarkup)
- [required](/help/youtrack/devportal/v1-Issue.html#required)
- [resumeSLA](/help/youtrack/devportal/v1-Issue.html#resumeSLA)
- [setDefaultFieldValues](/help/youtrack/devportal/v1-Issue.html#setDefaultFieldValues)
- [tag](/help/youtrack/devportal/v1-Issue.html#tag)
- [untag](/help/youtrack/devportal/v1-Issue.html#untag)
- [was](/help/youtrack/devportal/v1-Issue.html#was)

[GroupProjectCustomField](jetbrains__com__help__youtrack__devportal__v1-groupprojectcustomfield.md)[IssueAttachment](jetbrains__com__help__youtrack__devportal__v1-issueattachment.md)

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

