ツイートはてブ LINE Pocket

entities

ワークフローからアクセス可能な YouTrack 内のエンティティの定義が含まれています。

型階層

The following tree shows the complete inheritance structure for the entity types in this module.

BaseEntity

Supporting object types

The following object types are not part of the entity inheritance tree and don't have a documented parent:

タイプ

このモジュールは以下のオブジェクトの型をサポートします。

タイプ	説明
AbstractVcsItem	コミットやプルリクエストなどの VCS 関連の項目を表します。
Agile	アジャイルボードとそのボードに属する一連のスプリントを表します。
AppGlobalStorage	アプリグローバル拡張プロパティのエンティティタイプ
Article	YouTrack の記事を表します。
ArticleAttachment	記事に添付されているファイルを表します。
ArticleComment	記事または記事の下書きに追加されたコメントを表します。
BaseArticle	記事の基本クラス。
BaseArticleAttachment	記事コメントの基本クラス。
BaseArticleComment	記事コメントの基本クラス。
BaseComment	課題コメントの基底クラス。
BaseEntity	すべてのエンティティタイプに共通の先祖
BaseWorkItem	課題作業項目の基本クラス。
Build	ビルドタイプを格納するカスタムフィールドに格納される値を表します。
BundleElementCondition	特定のプロジェクトにおけるカスタムフィールドの値に基づく条件を表します。
BundleProjectCustomField	プロジェクト内のカスタムフィールドを表し、定義済みの値セットを保存します。
Calendar	ヘルプデスクプロジェクトにおける営業時間設定のグループを表します。ワークフロー API では、このようなグループはカレンダーと呼ばれます。
Calendar24x7	ヘルプデスクプロジェクトにおける、24 時間 365 日対応の営業時間設定のグループを表します。ワークフロー API では、このようなグループは Calendar24x7 と呼ばれます。
ChangesProcessor	VCS を取得するエンティティが変更され、YouTrack に表現が作成されます。
Channel	顧客がヘルプデスクにサポートを求めるために使用するチャネルを表します。
EnumField	定義済みの値セットを格納するカスタムフィールドの値を表します。
FeedbackForm	ヘルプデスクプロジェクトで使用されるオンラインフォームを表します。オンラインフォームは、顧客が問い合わせ、リクエスト、苦情を送信するために使用できる Web ベースのインターフェースを提供します。
Field	カスタムフィールドに格納される値を表します。カスタムフィールド自体は、 Fields クラスで表されます。
FieldBasedBundleValuesCondition	特定のプロジェクトにおけるカスタムフィールドの値に基づく条件を表します。
FieldBasedUserValuesCondition	ユーザーへの参照を格納するカスタムフィールドの値に基づく条件を表します。
FieldBasedValuesCondition	プロジェクト内のカスタムフィールドに対する値ベースの条件の基本エンティティを表します。
Fields	課題で使用されるカスタムフィールドを表します。各課題に使用されるカスタムフィールドの実際のセットは、プロジェクトごとに設定されます。ここに表示されているプロパティは、YouTrack のデフォルトのカスタムフィールドに対応しています。プロジェクトに紐付けられた追加のカスタムフィールドも利用可能です。
Gantt	ガントチャートを表します。
GroupProjectCustomField	プロジェクト内のカスタムフィールドを表し、 UserGroup 型を格納するものです。
Issue	YouTrack の課題を表します。 `Issue` エンティティは、課題データを読み取ったり変更したりするワークフロールールの中心的なエントリポイントです。課題ベースのルールでは、現在処理中の課題は `ctx.issue` として利用できます。
IssueAttachment	課題にアタッチされているファイルを表します。
IssueComment	課題に追加されたコメントを表します。
IssueLinkPrototype	課題リンクの種類を表します。
IssueTag	非推奨です。代わりに Tag を使用してください。
IssueWorkItem	課題に追加された作業項目を表します。
Iterator	コレクション内の要素を通過することを可能にするオブジェクト。
JsonForArticleAddAttachment	ワークフローやアプリ内の記事に追加するアタッチファイルを設定します。
JsonForArticleAddComment	ワークフローやアプリ内の記事に追加するコメントを設定します。
JsonForArticleConstructor	ワークフローやアプリで記事を作成する際に使用するデータを構成します。
JsonForIssueAddAttachment	ワークフローやアプリの課題に追加するアタッチファイルを設定します。
JsonForIssueAddComment	ワークフローやアプリ内の課題にコメントを追加するように設定します。
JsonForIssueAddWorkItem	ワークフローやアプリで、作業項目を課題に追加するように設定します。
JsonForIssueCommentAddAttachment	ワークフローやアプリの課題コメントに追加するアタッチファイルを設定します。
JsonForIssueConstructor	ワークフローやアプリで課題を作成する際に使用するデータを構成します。
JsonForUserNotify	ワークフローやアプリでユーザーに送信されるメール通知を設定します。
MailboxChannel	ヘルプデスクプロジェクトで使用されるメールチャネルを表します。メールチャネルは外部メールサービスからメッセージを取得し、チャネル設定に従って処理します。
OwnedField	ユーザー（いわゆる所有者）が関連付けられているカスタムフィールドの値を表します。
PeriodProjectCustomField	Represents a custom field in a project that stores a value as a period type. 周期値の基本クラスとして org.joda.time.Period を使用しています。クラスのドキュメントは http://joda-time.sourceforge.net/apidocs/org/joda/time/Period.html でご覧いただけますが、Period クラスと String や int などのプリミティブ型を使用するクラスメンバーのみをサポートしていることにご注意ください。
PersistentFile	YouTrack で使用可能なすべての永続ファイルの共通の祖先を表します。
Project	YouTrack プロジェクトを表します。
ProjectCustomField	プロジェクト内で使用可能なカスタムフィールドを表します。
ProjectTeam	プロジェクトチームを表します。 To access a project team in a workflow, use the `team` property of a `Project` object, such as `ctx.issue.project.team` , or the `teams` property of a `User` object. 規則要件では、プロジェクトチームを `UserGroup` として名前で参照してください。
ProjectType	プロジェクトで使用できる基本機能を決定する分類を表します。
ProjectVersion	バージョンタイプを格納するカスタムフィールドの値を表します。
PullRequest	課題にアタッチされたプルリクエストまたはマージリクエストを表します。
PullRequestState	プルリクエストの状態を表します。
Requirement	Requirements のセットの中の単一の要素
Requirements	The `requirements` object declares the fields and other YouTrack entities required by a workflow rule。 Before running the rule, YouTrack validates these declarations and exposes the resolved entities in the workflow context。
SavedQuery	保存された検索を表します。
Set	`Set` オブジェクトは、プリミティブ値やオブジェクト参照など、あらゆる型の一意の値を格納します。この API では、複数の値を格納するカスタムフィールド、課題リンク、プロジェクト内の課題など、すべての複数値オブジェクトの格納場所として Set が使用されます。 You can access single values in the collection directly (see `first()`、`last()`、`get(index)` ), use an iterator (see `entries()` , `values()`), or traverse with `forEach(visitor)` and `find(predicate)` methods. The workflow API is based on ECMAScript 5.1. This Set implementation mimics the functionality supported by the ES 6 セットインターフェース。
SimpleCalendar	YouTrack の稼働日カレンダーを表します。
SimpleProjectCustomField	文字列や数値などの単純な値を格納するカスタムフィールドの基底クラス。
Sprint	Represents a sprint that is associated with an agile board. Each sprint can include issues from one or more projects.
State	状態タイプを格納するカスタムフィールドの値を表します。
Tag	タグを表します。
TextProjectCustomField	文字列をテキストとして格納するカスタムフィールドを表します。課題に表示される場合、テキストは Markdown 形式で表示されます。
User	YouTrack のユーザーアカウントを表します。
UserAttributes	ユーザープロファイルに追加されたカスタム属性の集合を表します。参照ユーザーのプロファイルに保存されている値を取得するには、属性名をキーとして使用します。オブジェクト全体は読み取り専用です。
UserCondition	特定のプロジェクト内のカスタムフィールドに対する値ベースの条件を表します。このフィールドは、ユーザーへの参照を格納します。
UserGroup	ユーザーのグループを表します。
UserProjectCustomField	プロジェクト内のカスタムフィールドを表し、ユーザータイプとして値を保存します。
UserType	これは、高度なヘルプデスク機能へのアクセスを定義する分類を表し、YouTrack の各ユーザーアカウントに関連付けられた価格設定を規制するために使用されます。
VcsChange	課題にアタッチされたコミットを表します。
VcsServer	VCS サーバーを表します。
WatchFolder	タグと保存された検索を表すクラスの共通の先祖を表します。
WorkItemAttributeValue	作業項目属性の値。
WorkItemAttributes	プロジェクトレベルで作業項目に対して宣言されたカスタム属性の集合を表します。参照先の作業項目の属性に格納されている値を取得するには、属性名をキーとして使用します。
WorkItemProjectAttribute	プロジェクトに設定された作業項目属性。
WorkItemType	作業項目に割り当てることができる作業の種類を表します。

関数

actionFunction

actionFunction(ctx)

この関数は、ルールタイプに応じてさまざまなイベントによって呼び出されます。変更が issue に適用されたとき（変更時のルール）、コマンドが実行されたとき（アクションルール）、または事前定義されたスケジュールに従って（スケジュールルール）。この関数は、関連する課題ごとに別々に呼び出されます。

パラメーター

名前	タイプ	説明
ctx	オブジェクト	実行コンテキスト以下に一覧表示されているパラメーターとともに、コンテキストには Requirements で記述したオブジェクトも含まれています。

ctx の特性

名前	タイプ	説明
課題	Issue	今号です。
現在のユーザー	User	ルールを実行したユーザー。
サイレントオペレーション	Boolean	`true` の場合、ルールは通知なしに適用されたコマンドに反応してトリガーされます。`false` の場合、ルールは通常通り適用されたコマンドに反応してトリガーされます。 2017.4.38771 以降入手可能です。
invokeAsync	関数	現在のトランザクションがコミットされた後に実行される非同期関数をスケジュールします。非同期関数は、同じルールまたは AI ツールの `asyncFunctions` ブロック内で宣言する必要があります。署名: `ctx.invokeAsync(functionName, delay, deduplicationKey)` `functionName` -- 文字列、必須。`asyncFunctions` のキーと一致する必要があります。 `delay` -- 数値（省略可能）。遅延時間をミリ秒単位で指定します。デフォルトは `0` で、最大 7 日間まで指定できます。 `deduplicationKey` -- 文字列、オプション。設定されている場合、YouTrack は同じキーとエントリ構成を使用する以前にスケジュールされた非同期呼び出しをすべて置き換えます。プロジェクトレベルのルールの場合、これは同じルールとプロジェクトの組み合わせを意味します。グローバルレベルのルールの場合、これは同じルールとグローバル設定の組み合わせを意味します。古い呼び出しは削除され、新しい呼び出しは新たな遅延時間で開始されます。このパラメーターを使用すると、繰り返し発生するイベントをデバウンスして、最新の呼び出しのみが実行されるようになります。 2026.2 以降入手可能です。
店	関数	後続の非同期関数で使用するための値を格納します。署名: `ctx.store(key, value)` `key` -- 文字列、必須。格納されている値の識別子。 `value` -- 必須。プリミティブ (`string`、`number`、`boolean`)、`null`、エンティティ参照 (例: `Issue` または `User` ) を指定できます。保存された値は、`ctx.load(key)` を介して後続の非同期関数で使用できます。値は、同じ実行で非同期関数または非同期 HTTP 呼び出しがスケジュールされた場合にのみ保持されます。非同期呼び出しがスケジュールされない場合は、値は破棄されます。 2026.2 以降入手可能です。
負荷	関数	`ctx.store(key, value)` で以前に保存された値を取得します。署名: `ctx.load(key)` `key` は必須項目であり、文字列識別子でなければなりません。このメソッドは格納されている値を返します。エンティティ参照はすべて自動的に対応するエンティティオブジェクトに解決されます。このメソッドは非同期関数内でのみ使用可能です。 2026.2 以降入手可能です。

サンプル

action: function(ctx) { console.log('Action for issue ' + ctx.issue.id); }

guardFunction

guardFunction(ctx)

この関数は、アクション関数を課題に適用できるかどうかを判断するために呼び出されます。ガード関数は、変更時ルール、アクションルール、ステートマシンルールの値間の遷移で使用されます。スケジュールルールもガード関数をサポートしていますが、このルールタイプには同様の目的を持つ search プロパティが含まれています。

パラメーター

名前	タイプ	説明
ctx	オブジェクト	実行コンテキスト以下にリストされているパラメーターと一緒に、コンテキストには Requirements として記述するオブジェクトも含まれています。

ctx の特性

名前	タイプ	説明
課題	Issue	今号です。
現在のユーザー	User	ルールを実行したユーザー。

サンプル

guard: function(ctx) { return ctx.issue.State.isResolved; }

slaActionFunction

slaActionFunction(ctx)

この関数は、SLA ポリシーがチケットを更新する必要がある場合に呼び出されます。例: SLA の一時停止設定に従ってタイマーを一時停止したり、顧客からの新しいコメントがあるときにタイマーを再開したりできます。SLA ポリシースクリプトのみがこの機能を使用します。

パラメーター

名前	タイプ	説明
ctx	オブジェクト	実行コンテキスト以下にリストされているパラメーターと一緒に、コンテキストには Requirements として記述するオブジェクトも含まれています。

ctx の特性

名前	タイプ	説明
課題	Issue	現在のチケット。
現在のユーザー	User	更新を行ったユーザー。その後、SLA ポリシーによってチケットが更新されます。

サンプル

action: (ctx) => { console.log('action', ctx.issue.id); }

slaBreachFunction

slaBreachFunction(ctx)

この関数は、SLA ゴールの 1 つが違反されたときに呼び出されます。SLA ポリシースクリプトのみがこの機能を使用します。

パラメーター

名前	タイプ	説明
ctx	オブジェクト	実行コンテキスト以下にリストされているパラメーターと一緒に、コンテキストには Requirements として記述するオブジェクトも含まれています。

ctx の特性

名前	タイプ	説明
違反したフィールド	オブジェクト	このチケットのゴール時間に違反したタイマーカスタムフィールド。
課題	Issue	現在のチケット。
現在のユーザー	User	この機能をトリガーするアクターとみなされる特別なワークフローユーザー。これは、完全な権限セットが付与されたシステムユーザーアカウントです。

サンプル

onBreach: (ctx) => { console.log('onBreach', ctx.issue.id, ctx.breachedField); }

slaEnterFunction

slaEnterFunction(ctx)

この関数は、SLA ポリシーがチケットに適用され始めるときに呼び出されます。例: SLA 設定に従ってタイマーを初期化します。SLA ポリシースクリプトのみがこの機能を使用します。

パラメーター

名前	タイプ	説明
ctx	オブジェクト	実行コンテキスト以下にリストされているパラメーターと一緒に、コンテキストには Requirements として記述するオブジェクトも含まれています。

ctx の特性

名前	タイプ	説明
課題	Issue	現在のチケット。
現在のユーザー	User	更新を行ったユーザー。その後、SLA ポリシーがこのチケットに適用されます。

サンプル

onEnter: (ctx) => { console.log('onEnter', ctx.issue.id); }

slaGuardFunction

slaGuardFunction(ctx)

この関数は、SLA ポリシーをチケットに適用できるかどうかを判断するために呼び出されます。SLA ポリシースクリプトのみがこの機能を使用します。

パラメーター

名前	タイプ	説明
ctx	オブジェクト	実行コンテキスト以下にリストされているパラメーターと一緒に、コンテキストには Requirements として記述するオブジェクトも含まれています。

ctx の特性

名前	タイプ	説明
課題	Issue	現在のチケット。
現在のユーザー	User	更新を行ったユーザー。その後、SLA ポリシーがこのチケットに適用されます。

サンプル

guard: (ctx) => { return false; }

2026 年 10 月 02 日

YouTrack 開発者ポータルヘルプ

entities

型階層

Supporting object types

タイプ

関数

actionFunction

guardFunction

slaActionFunction

slaBreachFunction

slaEnterFunction

slaGuardFunction

関連ページ：