YouTrack および Hub ヘルプの開発者ポータル

entities

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

タイプ

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

タイプ

説明

AbstractVcsItem

コミットやプルリクエストなどの VCS 関連の項目を表します。

Agile

アジャイルボードとそのボードに属する一連のスプリントを表します。

AppGlobalStorage

アプリのグローバル拡張プロパティのエンティティタイプ

Article

YouTrack の記事を表します。

ArticleAttachment

記事に添付されているファイルを表します。

ArticleComment

記事に追加されるコメントを表します。

BaseArticle

記事の基本クラス。

BaseArticleAttachment

記事コメントの基本クラス。

BaseArticleComment

記事コメントの基本クラス。

BaseComment

課題コメントの基本クラス。

BaseEntity

すべてのエンティティタイプに共通の先祖

BaseWorkItem

課題作業項目の基本クラス。

Build

ビルドタイプを格納するカスタムフィールドに格納されている値を表します。

BundleProjectCustomField

事前定義された値のセットを保存するプロジェクト内のカスタムフィールドを表します。

Calendar

ヘルプデスクプロジェクトの営業時間設定のグループを表します。ワークフロー API では、このようなグループをカレンダーと呼びます。

Calendar24x7

ヘルプデスクプロジェクトの 24 時間 365 日の営業時間設定のグループを表します。ワークフロー API では、このようなグループは Calendar24x7 と呼ばれます。

ChangesProcessor

VCS を取得するエンティティが変更され、YouTrack に表現が作成されます。

Channel

顧客がヘルプデスクにサポートを求めるために使用するチャネルを表します。

EnumField

定義済みの一連の値を格納するカスタムフィールド内の値を表します。

FeedbackForm

ヘルプデスクプロジェクトで使用されるオンラインフォームを表します。オンラインフォームは、顧客が問い合わせ、リクエスト、苦情を送信するために使用できる Web ベースのインターフェースを提供します。

Field

カスタムフィールドに格納されている値を表します。カスタムフィールド自体は Fields クラスによって表されます。

Fields

issue で使用されているカスタムフィールドを表します。各号に使用されるカスタムフィールドの実際のセットは、プロジェクトごとに設定されています。ここに示すプロパティは、YouTrack のデフォルトのカスタムフィールドに対応しています。プロジェクトにアタッチされている追加のカスタムフィールドも利用できます。

Gantt

ガントチャートを表します。

GroupProjectCustomField

UserGroup 型を格納するプロジェクト内のカスタムフィールドを表します。

Issue

YouTrack の課題を表します。

IssueAttachment

課題に添付されているファイルを表します。

IssueComment

課題に追加されたコメントを表します。

IssueLinkPrototype

発行リンクタイプを表します。

IssueTag

非推奨。代わりにタグを使用してください。

IssueWorkItem

課題に追加された作業項目を表します。

Iterator

コレクション内の要素を通過することを可能にするオブジェクト。

JsonForArticleAddComment
JsonForArticleConstructor
JsonForIssueAddAttachment
JsonForIssueAddComment
JsonForIssueAddWorkItem
JsonForIssueCommentAddAttachment
JsonForIssueConstructor
JsonForUserNotify
MailboxChannel

ヘルプデスクプロジェクトで使用されるメールチャネルを表します。メールチャネルは外部メールサービスからメッセージを取得し、チャネル設定に従って処理します。

OwnedField

ユーザーが関連付けられているカスタムフィールド内の値、いわゆる所有者を表します。

PeriodProjectCustomField

期間タイプとして値を格納するプロジェクト内のカスタムフィールドを表します。期間値の基本クラスとして org.joda.time.Period を使います。http://joda-time.sourceforge.net/apidocs/org/joda/time/Period.html のクラスドキュメントを読むことができますが、サポートしているのは Period クラスと String や int などのプリミティブ型を使用するクラスメンバーだけです。

PersistentFile

YouTrack で使用可能なすべての永続ファイルの共通の祖先を表します。

Project

YouTrack プロジェクトを表します。

ProjectCustomField

プロジェクトで利用可能なカスタムフィールドを表します。

ProjectType

プロジェクトで使用できる基本機能を決定する分類を表します。

ProjectVersion

バージョンタイプを格納するカスタムフィールドの値を表します。

PullRequest

課題に添付されているプルまたはマージ要求を表します。

PullRequestState

プルリクエストの状態を表します。

Requirement

Requirements のセットの中の単一の要素

Requirements

`Requirements` オブジェクトは二つの目的を果たします。まず、安全策として機能します。ルールが期待通りに機能するために存在しなければならないエンティティのセットを指定します。1 つ以上のルール要件が満たされていない場合は常に、対応するエラーがワークフロー管理 UI に表示されます。すべての課題が解決されるまで、ルールは実行されません。第二に、参照として機能します。要件内の各エンティティは `context` オブジェクトにプラグインされているため、コンテキスト依存関数の中からエンティティを参照することができます(` action` 関数のように)。要件には、プロジェクト全体とシステム全体の 2 種類があります。プロジェクト全体の要件には、ルールを使用する各プロジェクトにアタッチする必要があるカスタムフィールドのリストと、各カスタムフィールドの値のセットから必要な値が含まれています。システム全体の要件は YouTrack で利用可能でなければならない他のエンティティのリストを含みます。これには、ユーザー、グループ、プロジェクト、issue、タグ、保存された検索、issue のリンクタイプが含まれます。

SavedQuery

保存された検索を表します。

Set

`Set` オブジェクトは、プリミティブな値であろうとオブジェクト参照であろうと、あらゆるタイプの一意の値を格納します。Set は、この API のすべての複数値オブジェクトの格納場所として使用されます。複数の値を格納するカスタムフィールド、リンクの発行、プロジェクト内の発行などです。コレクション内の単一の値に直接アクセスするか(first()、last()、get(index) を参照)、反復子を使用する(entries()、values() を参照)、forEach(visitor) メソッドを使用して検索(述語)することができます。ワークフロー API は ECMAScript 5.1 に基づいています。この Set 実装は ES 6 セットインターフェースでサポートされている機能を模倣しています。

SimpleCalendar

YouTrack の稼働日カレンダーを表します。

SimpleProjectCustomField

文字列や数値などの単純な値を格納するカスタムフィールドの基本クラス。

Sprint

アジャイルボードに関連付けられているスプリントを表します。各スプリントには、1 つ以上のプロジェクトからの課題を含めることができます。

State

状態タイプを格納するカスタムフィールドの値を表します。

Tag

タグを表します。

TextProjectCustomField

文字列をテキストとして格納するカスタムフィールドを表します。issue に表示されると、テキストは Markdown でフォーマットされたとおりに表示されます。

User

YouTrack のユーザーアカウントを表します。

UserAttributes

ユーザープロファイルに追加されたカスタム属性のコレクションを表します。参照されたユーザーのプロファイルに保存されている値を取得するには、属性名をキーとして使用します。オブジェクト全体は読み取り専用です。

UserGroup

ユーザーのグループを表します。

UserProjectCustomField

ユーザータイプとして値を格納するプロジェクト内のカスタムフィールドを表します。

VcsChange

課題に関連付けられているコミットを表します。

VcsServer

VCS サーバーを表します。

WatchFolder

タグと保存された検索を表すクラスの共通の先祖を表します。

WorkItemAttributeValue

作業項目属性の値。

WorkItemAttributes

プロジェクトレベルの作業項目に対して宣言されたカスタム属性のコレクションを表します。参照先の作業項目の属性に格納されている値を取得するには、属性名をキーとして使用します。

WorkItemProjectAttribute

プロジェクトに設定された作業項目属性。

WorkItemType

作業項目に割り当てることができる作業の種類を表します。

XdSlaPausedInterval

SLA の一時停止間隔を開始時刻と停止時刻で表します

関数

actionFunction

actionFunction(ctx, ctx.issue, ctx.currentUser, ctx.isSilentOperation)

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

パラメーター

名前

タイプ

説明

ctx

オブジェクト

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

ctx.issue

課題

今号です。

ctx.currentUser

ユーザー

ルールを実行したユーザー。

ctx.isSilentOperation

Boolean

true の場合、通知なしに適用されるコマンドに応じてルールが起動されます。`false` の場合、通常適用されるコマンドに反応してルールが起動されます。2017.4.38771 から利用可能です。

サンプル

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

guardFunction

guardFunction(ctx, ctx.issue, ctx.currentUser)

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

パラメーター

名前

タイプ

説明

ctx

オブジェクト

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

ctx.issue

課題

今号です。

ctx.currentUser

ユーザー

ルールを実行したユーザー。

サンプル

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

slaActionFunction

slaActionFunction(ctx, ctx.issue, ctx.currentUser)

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

パラメーター

名前

タイプ

説明

ctx

オブジェクト

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

ctx.issue

課題

現在のチケット。

ctx.currentUser

ユーザー

更新を行ったユーザー。その後、SLA ポリシーによってチケットが更新されます。

サンプル

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

slaBreachFunction

slaBreachFunction(ctx, ctx.breachedField, ctx.issue, ctx.currentUser)

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

パラメーター

名前

タイプ

説明

ctx

オブジェクト

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

ctx.breachedField

オブジェクト

このチケットのゴール時間に違反したタイマーカスタムフィールド。

ctx.issue

課題

現在のチケット。

ctx.currentUser

ユーザー

この機能をトリガーするアクターとみなされる特別なワークフローユーザー。これは、完全な権限セットが付与されたシステムユーザーアカウントです。

サンプル

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

slaEnterFunction

slaEnterFunction(ctx, ctx.issue, ctx.currentUser)

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

パラメーター

名前

タイプ

説明

ctx

オブジェクト

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

ctx.issue

課題

現在のチケット。

ctx.currentUser

ユーザー

更新を行ったユーザー。その後、SLA ポリシーがこのチケットに適用されます。

サンプル

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

slaGuardFunction

slaGuardFunction(ctx, ctx.issue, ctx.currentUser)

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

パラメーター

名前

タイプ

説明

ctx

オブジェクト

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

ctx.issue

課題

現在のチケット。

ctx.currentUser

ユーザー

更新を行ったユーザー。その後、SLA ポリシーがこのチケットに適用されます。

サンプル

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