---
schema: rendered-html/v1
title: "Fields | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/v1-Fields.html
generated_at: 2026-06-11T15:16:39.259425+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](v1-Fields.html)
- [Gantt](jetbrains__com__help__youtrack__devportal__v1-gantt.md)
- [GroupProjectCustomField](jetbrains__com__help__youtrack__devportal__v1-groupprojectcustomfield.md)
- [Issue](jetbrains__com__help__youtrack__devportal__v1-issue.md)
- [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. [Fields](#0)

# Fields﻿

Last modified: 07 May 2026

Represents the custom fields that are used in an issue. The actual set of custom fields that are used for each issue is configured on a per-project basis. The properties shown here correspond with the default custom fields in YouTrack. Additional custom fields that have been attached to a project are also available.

## Methods﻿

### becomes﻿

static becomes(field, expected)

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


| --- | --- | --- |
| field | string, ProjectCustomField | The field to check. |
| expected | Object | The expected value. |

**Return Value**

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

### canBeReadBy﻿

static canBeReadBy(field, user)

Checks whether a user has permission to read the custom field.


| --- | --- | --- |
| field | string, ProjectCustomField | The custom field to check for read access. |
| user | User | The user for whom the permission to read the custom field is checked. |

**Return Value**

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

### canBeWrittenBy﻿

static canBeWrittenBy(field, user)

Checks whether a user has permission to update the custom field.


| --- | --- | --- |
| field | string, ProjectCustomField | The custom field to check for update access. |
| user | User | The user for whom the permission to update the custom field is checked. |

**Return Value**

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

### isChanged﻿

static isChanged(field)

Checks whether the custom field is changed in the current transaction.


| --- | --- | --- |
| field | string, ProjectCustomField | The name of the custom field (for example, 'State') or a reference to the field that is checked. |

**Return Value**

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

### oldValue﻿

static oldValue(field)

Returns the previous value of a single-valued custom field before an update was applied. If the field is not changed in the transaction, returns null.


| --- | --- | --- |
| field | string, ProjectCustomField | The name of the custom field (for example, 'State') or a reference to the field for which the previous value is returned. |

**Return Value**

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

### required﻿

static required(fieldName, message)

Asserts that a value is set for a custom 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 custom field to check. |
| message | string | The message that is displayed to the user that describes the field requirement. |

- [Fields](/help/youtrack/devportal/v1-Fields.html)
- [Methods](/help/youtrack/devportal/v1-Fields.html#methods)
- [becomes](/help/youtrack/devportal/v1-Fields.html#becomes)
- [canBeReadBy](/help/youtrack/devportal/v1-Fields.html#canBeReadBy)
- [canBeWrittenBy](/help/youtrack/devportal/v1-Fields.html#canBeWrittenBy)
- [isChanged](/help/youtrack/devportal/v1-Fields.html#isChanged)
- [oldValue](/help/youtrack/devportal/v1-Fields.html#oldValue)
- [required](/help/youtrack/devportal/v1-Fields.html#required)

[FieldBasedValuesCondition](jetbrains__com__help__youtrack__devportal__v1-fieldbasedvaluescondition.md)[Gantt](jetbrains__com__help__youtrack__devportal__v1-gantt.md)

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

