Reporting Work Item Revisions - Read Reporting Revisions Get
削除済みアイテムを含むオプションを使用して、作業項目のリビジョンのバッチを取得する
GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?api-version=4.1
GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?fields={fields}&types={types}&continuationToken={continuationToken}&startDateTime={startDateTime}&includeIdentityRef={includeIdentityRef}&includeDeleted={includeDeleted}&includeTagRef={includeTagRef}&includeLatestOnly={includeLatestOnly}&$expand={$expand}&includeDiscussionChangesOnly={includeDiscussionChangesOnly}&$maxPageSize={$maxPageSize}&api-version=4.1
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
project
|
path |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '4.1' に設定する必要があります。 |
$expand
|
query |
既定では返されない長いテキスト フィールドを含む、作業項目の変更のすべてのフィールドを返します |
||
$max
|
query |
integer int32 |
このバッチで返される結果の最大数 |
|
continuation
|
query |
string |
バッチを開始する基準値を指定します。 リビジョンの最初のバッチを取得するには、このパラメーターを省略します。 |
|
fields
|
query |
string array (string) |
作業項目のリビジョンで返されるフィールドの一覧。 レポート可能なすべてのフィールドを取得するには、このパラメーターを省略します。 |
|
include
|
query |
boolean |
削除されたアイテムを返す必要があるかどうかを指定します。 |
|
include
|
query |
boolean |
履歴フィールドのみが変更された作業項目の変更のみを返します |
|
include
|
query |
boolean |
ID フィールドの文字列値の代わりに ID 参照を返します。 |
|
include
|
query |
boolean |
すべての履歴リビジョンをスキップして、作業項目の最新のリビジョンのみを返します |
|
include
|
query |
boolean |
System.Tags フィールドにタグ オブジェクトを返す必要があるかどうかを指定します。 |
|
start
|
query |
string date-time |
リビジョンの開始点として使用する日付/時刻。すべてのリビジョンは、この日付/時刻より後に発生します。 'watermark' パラメーターと組み合わせて使用することはできません。 |
|
types
|
query |
string array (string) |
結果を特定の作業項目の種類にフィルター処理する型の一覧。 すべての作業項目の種類の作業項目のリビジョンを取得するには、このパラメーターを省略します。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
正常な操作 |
セキュリティ
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
名前 | 説明 |
---|---|
vso.work | 作業項目、クエリ、ボード、領域およびイテレーション パス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、クエリを実行したり、サービス フックを介して作業項目イベントに関する通知を受信したりすることもできます。 |
例
Get a batch of work item revisions with identity references |
Get the first batch of work item revisions |
Get a batch of work item revisions with identity references
Sample Request
GET https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?includeIdentityRef=true&api-version=4.1
Sample Response
{
"values": [
{
"id": 3,
"rev": 8,
"fields": {
"System.Id": 3,
"System.AreaPath": "Fabrikam-Fiber-Git",
"System.TeamProject": "Fabrikam-Fiber-Git",
"System.Rev": 8,
"System.RevisedDate": "9999-01-01T00:00:00Z",
"System.IterationPath": "Fabrikam-Fiber-Git\\Release 1\\Sprint 1",
"System.WorkItemType": "Product Backlog Item",
"System.State": "Done",
"System.Reason": "Work finished",
"System.CreatedDate": "2014-03-18T17:17:06.857Z",
"System.CreatedBy": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "Jamal Hartnett <fabrikamfiber4@hotmail.com>"
},
"System.ChangedDate": "2015-06-23T18:25:16.137Z",
"System.ChangedBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"uniqueName": "Normal Paulk <fabrikamfiber16@hotmail.com>"
},
"System.Title": "Technician can submit invoices on Windows Phone",
"System.BoardColumn": "Done",
"Microsoft.VSTS.Common.ClosedDate": "2014-03-18T17:19:02.093Z",
"Microsoft.VSTS.Common.Priority": 3,
"Microsoft.VSTS.Common.BacklogPriority": 1000063244,
"WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "Done"
}
},
{
"id": 350,
"rev": 1,
"fields": {
"System.Id": 350,
"System.AreaPath": "Fabrikam-Fiber-Git",
"System.TeamProject": "Fabrikam-Fiber-Git",
"System.Rev": 1,
"System.RevisedDate": "9999-01-01T00:00:00Z",
"System.IterationPath": "Fabrikam-Fiber-Git",
"System.WorkItemType": "Epic",
"System.State": "New",
"System.Reason": "New epic",
"System.CreatedDate": "2015-08-25T21:54:46.06Z",
"System.CreatedBy": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "Jamal Hartnett <fabrikamfiber4@hotmail.com>"
},
"System.ChangedDate": "2015-08-25T21:54:46.06Z",
"System.ChangedBy": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "Jamal Hartnett <fabrikamfiber4@hotmail.com>"
},
"System.Title": "Mobile Experiences",
"System.BoardColumn": "New",
"System.BoardColumnDone": false,
"Microsoft.VSTS.Common.Priority": 2,
"WEF_DF2CD50AB7B849C795850408B629AB43_Kanban.Column": "New",
"WEF_DF2CD50AB7B849C795850408B629AB43_Kanban.Column.Done": false
}
}
],
"nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=813;350;1&includeIdentityRef=true&api-version=2.0",
"continuationToken": "813;350;1",
"isLastBatch": true
}
Get the first batch of work item revisions
Sample Request
GET https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?api-version=4.1
Sample Response
{
"values": [
{
"id": 1,
"rev": 1,
"fields": {
"System.Id": 1,
"System.AreaPath": "Fabrikam-Fiber-Git",
"System.TeamProject": "Fabrikam-Fiber-Git",
"System.Rev": 1,
"System.RevisedDate": "2014-03-18T17:17:05.76Z",
"System.IterationPath": "Fabrikam-Fiber-Git",
"System.WorkItemType": "Product Backlog Item",
"System.State": "New",
"System.Reason": "New backlog item",
"System.CreatedDate": "2014-03-18T17:16:56.25Z",
"System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.ChangedDate": "2014-03-18T17:16:56.25Z",
"System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.BoardColumn": "New",
"WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
"System.Title": "Technician can check on parts orders on Windows Phone"
}
},
{
"id": 1,
"rev": 2,
"fields": {
"System.Id": 1,
"System.AreaPath": "Fabrikam-Fiber-Git",
"System.TeamProject": "Fabrikam-Fiber-Git",
"System.Rev": 2,
"System.RevisedDate": "2014-03-18T17:19:02.093Z",
"System.IterationPath": "Fabrikam-Fiber-Git",
"System.WorkItemType": "Product Backlog Item",
"System.State": "New",
"System.Reason": "New backlog item",
"System.CreatedDate": "2014-03-18T17:16:56.25Z",
"System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.ChangedDate": "2014-03-18T17:17:05.76Z",
"System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.BoardColumn": "New",
"WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
"System.Title": "Technician can check on parts orders on Windows Phone",
"Microsoft.VSTS.Common.BacklogPriority": 1000000000
}
},
{
"id": 2,
"rev": 1,
"fields": {
"System.Id": 2,
"System.AreaPath": "Fabrikam-Fiber-Git",
"System.TeamProject": "Fabrikam-Fiber-Git",
"System.Rev": 1,
"System.RevisedDate": "2014-03-18T17:17:06.343Z",
"System.IterationPath": "Fabrikam-Fiber-Git",
"System.WorkItemType": "Product Backlog Item",
"System.State": "New",
"System.Reason": "New backlog item",
"System.CreatedDate": "2014-03-18T17:17:06.01Z",
"System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.ChangedDate": "2014-03-18T17:17:06.01Z",
"System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.BoardColumn": "New",
"WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
"System.Title": "Technician can look for closest hardware store from Windows Phone"
}
}
],
"nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=3;2;1&api-version=2.0",
"isLastBatch": true
}
定義
名前 | 説明 |
---|---|
Reporting |
既定では返されない長いテキスト フィールドを含む、作業項目の変更のすべてのフィールドを返します |
Reporting |
ReportingRevisionsExpand
既定では返されない長いテキスト フィールドを含む、作業項目の変更のすべてのフィールドを返します
名前 | 型 | 説明 |
---|---|---|
fields |
string |
|
none |
string |
ReportingWorkItemRevisionsBatch
名前 | 型 | 説明 |
---|---|---|
continuationToken |
string |
|
isLastBatch |
boolean |
|
nextLink |
string |
|
values |
string[] |