課題履歴を取得する
YouTrack REST API を使用して、特定の課題に適用された変更の履歴を取得します。
要約
特定の課題の変更履歴を読み取るには、課題アクティビティエンドポイントに GET リクエストを送信します。
リクエストパラメーター
履歴変更のコレクションは、単一のリクエストでアクセスできます。必要なアクティビティ項目を取得するには、リクエストに追加するパラメーターに注意してください。
categories— この必須パラメーターは、特定の種類の履歴変更をフィルタリングします。各リクエストに対して、少なくとも 1 つのカテゴリを指定してください。サポートされているカテゴリの一覧については、ActivityCategory を参照してください。fields— このパラメーターは、サーバーが応答として返す属性をリストしたものです。課題履歴項目については、以下の属性を要求することをお勧めします。authorを使用して、誰が変更を適用したかを確認します。addedを使用して、課題に追加された値を確認します。removedを使用して、課題から削除された値を確認します。
サポートされる属性のリストは、
categoriesパラメーターを使用して要求するアクティビティの型によって異なります。サポートされているアクティビティ項目とその属性のリストについては、ActivityItem を参照してください。{issue ID}は、対象となる課題の一意の ID を表します。課題は、エンティティ ID(例:2-32)または人間が読みやすい ID(例:SP-32)で識別できます。
単一のリクエストですべての課題履歴にアクセスできるため、このユースケースでは段階的な手順説明は必要ありません。
追加情報
このエンドポイントは、1 つの課題に関するアクティビティを返します。複数の課題にわたって特定のユーザーが作成したアクティビティ項目を取得するには、GET 活動アイテムを author パラメーターとともに使用し、必要に応じて issueQuery パラメーターを使用して一致する課題を絞り込みます。例:
REST API を使用せずに YouTrack でこの情報を監視したい場合は、課題活動フィードウィジェットを使用し、作成者を変更するフィルターを設定してください。
サンプルリクエスト
このサンプルリクエストでは、課題「SP-32」の変更履歴を読み取り、次のカテゴリに一致する変更のリストを返すようにサーバーに指示します。
CustomFieldCategory— ターゲット課題のカスタムフィールドに適用された変更のコレクション。CommentsCategory— この課題のコメントに変更が適用されました。
属性については、上記で推奨した属性 author、added、removed をリクエストしましょう。さらに、timestamp 属性をリクエストして、これらの変更がいつ適用されたかを確認しましょう。コメントアクティビティアイテムのデータをさらに取得するために、target(id,text) 属性も指定しましょう。コメント ID とテキストが表示されます。
最終的に、fields パラメーターは次のようになります。
完全なリクエストは次のとおりです。
それに応じて、サーバーは次のデータを返します。
関連ページ:
ActivityCategory
類似した性質のすべての活動を表します。次の表は、使用可能なアクティビティカテゴリとそれに一致するアクティビティアイテムを示しています。アクティビティ関連のリソースに対する要求のクエリパラメーターで、カテゴリ ID を指定する必要があります。ArticleCommentAttachmentsCategoryCommentAttachmentsActivityItem、ArticleTagsCategoryTagsActivityItem、AttachmentRecognizedTextCatego...
アクティビティフィードウィジェットの発行
課題アクティビティフィードウィジェットを使用すると、YouTrack ユーザーが課題に加えた変更を監視できます。特定の条件に一致する、特定のユーザーによる課題の変更を表示するようにアクティビティを設定できます。ウィジェットには、過去 90 日間に指定された条件に一致する課題の最近の変更が表示されます。ダッシュボードに課題アクティビティフィードウィジェットを追加するには: メインナビゲーションメニューから、ダッシュボードを選択します。ウィジェットのダッシュボードを選択します。ダッシュボードのウィジェ...