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

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- 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
- FieldBasedValuesCondition
- Fields
- Gantt
- GroupProjectCustomField
- Issue
- IssueAttachment
- IssueComment
- IssueLinkPrototype
- IssueTag
- IssueWorkItem
- Iterator
- JsonForArticleAddAttachment
- JsonForArticleAddComment
- JsonForArticleConstructor
- JsonForIssueAddAttachment
- JsonForIssueAddComment
- JsonForIssueAddWorkItem
- JsonForIssueCommentAddAttachment
- JsonForIssueConstructor
- JsonForUserNotify
- MailboxChannel
- OwnedField
- [PeriodProjectCustomField](jetbrains__com__help__youtrack__devportal__v1-periodprojectcustomfield.md)
- [PersistentFile](jetbrains__com__help__youtrack__devportal__v1-persistentfile.md)
- [Project](jetbrains__com__help__youtrack__devportal__v1-project.md)
- [ProjectCustomField](jetbrains__com__help__youtrack__devportal__v1-projectcustomfield.md)
- [ProjectTeam](jetbrains__com__help__youtrack__devportal__v1-projectteam.md)
- [ProjectType](jetbrains__com__help__youtrack__devportal__v1-projecttype.md)
- [ProjectVersion](jetbrains__com__help__youtrack__devportal__v1-projectversion.md)
- [PullRequest](jetbrains__com__help__youtrack__devportal__v1-pullrequest.md)
- [PullRequestState](jetbrains__com__help__youtrack__devportal__v1-pullrequeststate.md)
- [Requirement](v1-Requirement.html)
- [Requirements](jetbrains__com__help__youtrack__devportal__v1-requirements.md)
- 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. [Requirement](#0)

# Requirement﻿

Last modified: 07 May 2026

A single element in a set of [Requirements](jetbrains__com__help__youtrack__devportal__v1-requirements.md)

## Properties﻿

| Name | Type | Description |
| --- | --- | --- |
| id | string | An optional issue ID, used instead of name for Issue requirements. |
| inward | string | The inward name of the issue link type (equals outward name if not set). |
| login | string | An optional login, used instead of name for User requirements. |
| multi | boolean | An optional flag, `false` by default. If `true`, a required field must store multiple values (if applicable). |
| name | string | The optional name of the field or entity. If not provided, the key (alias) for this requirement in the [Requirements](jetbrains__com__help__youtrack__devportal__v1-requirements.md) object is used. |
| outward | string | The outward name of the issue link type (required for IssueLinkPrototype requirements). |
| type | string, Object | The data type of the entity. Can be one of the following custom field types: Build .fieldType, OwnedField .fieldType, State .fieldType, EnumField .fieldType, [ProjectVersion](jetbrains__com__help__youtrack__devportal__v1-projectversion.md) .fieldType, User .fieldType, UserGroup .fieldType, Field .dateType, Field .floatType, Field .integerType, Field .stringType, Field .periodType. Can also be one of the following system-wide entities: User, UserGroup, [Project](jetbrains__com__help__youtrack__devportal__v1-project.md), Issue, Tag, SavedQuery, IssueLinkPrototype. |

- [Requirement](/help/youtrack/devportal/v1-Requirement.html)
- [Properties](/help/youtrack/devportal/v1-Requirement.html#properties)

[PullRequestState](jetbrains__com__help__youtrack__devportal__v1-pullrequeststate.md)[Requirements](jetbrains__com__help__youtrack__devportal__v1-requirements.md)

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

Copyright © 2000–2026 JetBrains s.r.o.
