作業項目トラッキング
作業項目の追跡リソース
バグやタスクなど、チームの作業項目を取得、作成、更新します。 クエリを使うことで、作業項目クエリ言語の機能をフル活用して、作業項目を検索したりフィルター処理したりすることができます。 作業項目クエリ言語を使用することによって、クエリを満たす個々の作業項目を取得できます。 作業項目には完全な履歴が残っており、作業項目の各フル リビジョンを取得できるほか、各リビジョンに対して行われた更新だけを取得することもできます。 作業項目にタグを付けることはできません。
一般的なタスク
クエリを使用して作業項目を取得する
- 使用する クエリ を検索します。
- そのクエリの 結果 を取得します。
- 各 作業項目を ID で取得します。
バッチでの WorkItems の更新
Batch WorkItem Update API を使用して、作業項目をバッチで更新します。
作業項目のフィールドを更新する
2 つの作業項目のリンク
2 つの作業項目を作成してリンクする
作業項目の作成を使用し、バッチ呼び出しでリンク API を追加します。
作業項目にファイルを添付する
- 更新する 作業項目 の ID を取得します。
- 添付ファイルを添付 ファイル ストアにアップロードします。
- 作業項目に添付ファイルを追加 します。
作業項目の作成
作業項目を作成します。 少なくともタイトルを指定してください。 一部の種類の作業項目では、他のフィールドの値が必要になります。
作業項目の完全な履歴を取得する
作業項目を削除する
- 作業項目の ID を取得します。
- 作業項目を削除します。
チーム プロジェクトで使用されるフィールドを取得する
- チーム プロジェクトで使用される 作業項目の種類 を取得します。
- 各 作業項目の種類 を取得して、使用するフィールドを表示します。 (xmlform をスキップして fieldinstances に移動します)。
作業項目のカテゴリを取得する
作業項目のカテゴリを使用して、さまざまな機能のチーム プロジェクトで使用される作業項目の種類を取得します。 たとえば、バックログに表示される作業項目を表示するには、要件カテゴリを取得 します。
領域とイテレーションを取得する
チーム プロジェクトの 領域階層またはイテレーション階層 を取得します。
作業項目の関係の種類を取得する
プロジェクト コレクションで使用できる 作業項目のリンクの種類 を取得します。
作業項目メタデータ リソース
作業項目はメタデータによって管理されます。 メタデータの一部は特定のチーム プロジェクトにスコープ設定され、他のメタデータはプロジェクト コレクション (Azure DevOps Services アカウントの既定のコレクションなど) にスコープ設定されます。
プロジェクト スコープのメタデータ
チーム プロジェクトには、一連の 作業項目の種類があります。 各作業項目の種類は、プロジェクトでの役割を定義するための "要件" や "バグ" などの カテゴリ に属している場合があります。 分類ノード は、チーム プロジェクトの作業項目の領域と反復フィールドで使用できる値のセットを定義します。
- Categories (カテゴリ)
- 分類ノード (領域とイテレーション)
- 作業項目の種類
コレクション スコープのメタデータ
作業項目の種類は 、フィールド と 関係の種類 (リンクと添付ファイル) を 他の種類の作業項目と共有します。
作業項目バッチ更新 API
複数の作業項目の更新要求を実行します。 応答には、バッチ内の各要求に対する個々の応答が含まれます。 失敗した要求は、バッチ内の後続の要求には影響しません。
REST API セマンティクス
PATCH https://dev.azure.com/{organization}/_apis/wit/$batch?api-version=6.1
URI パラメーター
| 名前 | / | 必須 | Type | 説明 |
|---|---|---|---|---|
| organization | パス | True | string | Azure DevOps 組織の名前です。 |
| api-version | query | string | 使う API のバージョン。 | |
| bypassRules | query | boolean | この更新プログラムでは、作業項目の種類の規則を適用しないでください。 | |
| suppressNotifications | query | boolean | この変更に関する通知は一切発生しません。 |
要求本文
要求本文は、作業項目の更新要求の一覧として構成されます。 このリストの各項目は、REST メソッド、パス、ヘッダー、本文など、単一の Update Request に関するすべての情報を結び付けます。
単一要求の詳細については、作業項目の更新に関するドキュメントをチェックできます。
Batch Update の例
要求
PATCH https://dev.azure.com/fabrikam/_apis/wit/$batch?api-version=6.1
要求本文
[
{
// Add priority and test rev on work item with id 1
"method": "PATCH",
"uri": "/_apis/wit/workitems/1?api-version=6.1",
"headers": {
"Content-Type": "application/json-patch+json"
},
"body": [
{
"op": "test",
"path": "/rev",
"value": 3
},
{
"op": "add",
"path": "/fields/Microsoft.VSTS.Common.Priority",
"value": "1"
}
]
},
{
// Replace tags on work item with id 299x
"method": "PATCH",
"uri": "/_apis/wit/workitems/299?api-version=6.1",
"headers": {
"Content-Type": "application/json-patch+json"
},
"body": [
{
"op": "replace",
"path": "/fields/System.Tags",
"value": "Tag1; Tag2"
}
]
},
{
// You can also use Work Item Create format
"method": "PATCH",
"uri": "/mytestprojectname/_apis/wit/workitems/$Bug?api-version=4.1",
"headers": {
"Content-Type": "application/json-patch+json"
},
"body": [
{
"op": "add",
"path": "/id",
"value": "-1"
},
{
"op": "add",
"path": "/fields/System.Title",
"from": null,
"value": "Sample 1"
}
]
},
]
応答
応答は、バッチ処理された更新要求ごとに個別の応答で構成されます。
- count : 返されたバッチ更新応答の数
- value : 応答コード、ヘッダー、本文を含む応答オブジェクトの一覧
{
"count": 2,
"value": [
{
"code": 200,
"headers": {
"Content-Type": "application/json; charset=utf-8"
},
"body": "{work item object}"
},
{
"code": 200,
"headers": {
"Content-Type": "application/json; charset=utf-8"
},
"body": "{work item object}"
}
]
}