コマンドを課題に適用する
このページでは、RESTAPI を使用して YouTrack の 1 つ以上の課題にコマンドを適用する方法の例を示します。UI のコマンドと同様に、その REST API 実装により、1 つまたは複数の課題を含む操作をはるかに高速かつ簡単に実行できます。
要約
課題にコマンドを適用するには、コマンドクエリと対象の課題を含むリクエストボディを添えて、POST リクエストを /api/commands エンドポイントに送信します。オプションの属性を追加することで、コメントの追加、コメントの表示制限、通知の抑制なども可能です。
ステップバイステップ
課題にコマンドを適用するには:
課題に適用するコマンドクエリを選択してください。YouTrack ユーザーインターフェースで使用するコマンド構文と同じものを使用してください。
対象となる課題を特定します。課題は、データベースエンティティ ID(例:
"id":"2-1234")または人間が読みやすい ID(例:"idReadable":"SDP-345")で特定できます。リクエストボディを作成します。最小限のリクエストボディには、適用する
queryと、対象となる課題を特定するissuesの集合が含まれます。オプション。コメントを追加したり、コメントの表示を制限したり、通知を抑制したりする必要がある場合は、
comment、visibility、silentなどのコマンド属性を追加してください。コマンドエンドポイントに
POSTリクエストを送信します。/api/commands
コマンドを適用するための最小限の要求
以下のリクエストは、最小限のリクエストボディを持つコマンドを実行します。
fields パラメーターのないサンプルの最小要求の場合、サーバーは 200 OK ステータスと空の本文を含む応答を送信します。
コメントの表示が制限されたコマンド
次のリクエストは、特定の課題を現在のユーザーに割り当て、表示が制限された新しいコメントを追加します。
次のリクエストは、3 つの課題にタグを追加し、ユーザー「jane.doe」に割り当てます。
コマンドをサイレントに適用する
それでは、コマンドをサイレントに適用しましょう。つまり、次の要求は、変更に関する通知を送信しないように YouTrack に指示します。このようなサイレントコマンドは、多数の課題を同時に更新する必要がある場合に便利です。例: 次のバージョンのリリースまたはマイルストーンを計画していて、バージョンフィールドを設定または変更する必要がある場合。
コマンドをサイレントに適用するには、要求ペイロードで属性 "silent" を true に設定するだけです。このサンプルでは、前のサンプルのように「idReadable」ではなく、データベースエンティティ id によって課題を特定しました。