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

YouTrack REST API

YouTrack REST API を使用すると、トラッカーでプログラム的にさまざまなアクションを実行できます。

  • YouTrack へのスムーズな移行のために、現在のバグ追跡システムから課題をインポートします。

  • 課題のある他の操作を作成、変更、実行します。YouTrack を環境にシームレスに統合できます。例: サードパーティのアプリケーションからの自動化された課題の送信。

  • プロジェクト、カスタムフィールドと値のセット、アジャイルボード、課題リンク型、その他のパラメーターを操作します。

一般的な注意事項

REST API は、JSON 形式のデータを返し、使用します。通常のコンテンツネゴシエーション(英語)ルールが適用されます。

  • 要求ごとに許可 HTTP 要求ヘッダーを指定する必要があります。推奨される認証方法は、永久トークンを使用することです。永久トークンを取得する方法については、「永久トークンの管理」を参照してください。

    サポートされている認証方法の詳細については、「YouTrack にログインする」を参照してください。

  • 受諾 HTTP リクエストヘッダーを使用して、予期される応答データ形式を示します: application/json

  • POST および PUT 要求にはコンテンツタイプ HTTP リクエストヘッダーを使用します: application/json

REST API は常に有効です。ただし、システム管理者は、REST を使用して YouTrack へのアクセスを許可するサイト(オリジン)を指定できます。詳細については、グローバル設定の管理を参照してください。

YouTrack REST API に基づくツールとクライアントライブラリ

独自の開発に REST API を使い始める前に、YouTrack REST API を使ういくつかのツールを参照してください。

  • YouTrackSharp(英語) は YouTrack REST API にアクセスするための .NET ライブラリです。このライブラリは NuGet ギャラリー(英語)からも入手可能です。

  • YouTrack モバイル(英語)は、YouTrack インストールからデータをプルしてモバイルアプリに表示するために REST API を使用します。

  • IntelliJ IDEA およびその他の JetBrains IDE の YouTrack 統合プラグイン(英語)は、REST API を使用して、課題関連情報を IDE に直接表示します。

関連ページ:

永久トークンの管理

YouTrack および Hub の開発者ポータルでは、永久トークンにより、開発者は OAuth 2.0 認証フローを実装しなくても、スクリプトおよびアプリケーションで RESTAPI 呼び出しを使用して安全に操作にアクセスして実行できます。永久トークンは、ユーザーアカウントに付与されたアクセス許可を持つサービスへのアクセスを許可します。このページでは、ユーザープロファイルで実行される永久トークンを使用した操作について説明します。永久トークンを使用した RESTAPI 呼び出しのサンプルについて...

YouTrack にログインする

YouTrack は、ログインと外部クライアントからのデータアクセスに使用できる 2 つの認証方法をサポートしています。永久トークン認証永久トークンにより、スクリプトおよびアプリケーションでの RESTAPI 呼び出しのトークンベースの承認が可能になります。この機能により、YouTrack と外部サービスとの統合のセキュリティが向上します。YouTrack REST API を使用した許可には、永久トークンを使用することをお勧めします。OAuth 2.0 認証 OAuth 2.0 は、アプリケーシ...

フォーム API リファレンス

ここでは、フォーム API のリファレンスを見つけ、フォームへの接続を確立する方法を学習できます。接続を確立する:Form API を使用するための最初のステップは、フォームへの接続を確立することです。これを行うには、作業しているフォームの ID を指定して以下のサンプルコードを使用します。YTFeedbackForm.getClientJSApi('680e7600-000f-4029-bfe9-ddf479c73ef7').then(async form => { // Your c...