Reporting Work Item Revisions - Read Reporting Revisions Get
Get a batch of work item revisions with the option of including deleted items
GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?api-version=5.0
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=5.0
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path |
string |
Project ID or project name |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '5.0' to use this version of the api. |
$expand
|
query |
Return all the fields in work item revisions, including long text fields which are not returned by default |
||
$max
|
query |
integer int32 |
The maximum number of results to return in this batch |
|
continuation
|
query |
string |
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions. |
|
fields
|
query |
string array (string) |
A list of fields to return in work item revisions. Omit this parameter to get all reportable fields. |
|
include
|
query |
boolean |
Specify if the deleted item should be returned. |
|
include
|
query |
boolean |
Return only the those revisions of work items, where only history field was changed |
|
include
|
query |
boolean |
Return an identity reference instead of a string value for identity fields. |
|
include
|
query |
boolean |
Return only the latest revisions of work items, skipping all historical revisions |
|
include
|
query |
boolean |
Specify if the tag objects should be returned for System.Tags field. |
|
start
|
query |
string date-time |
Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter. |
|
types
|
query |
string array (string) |
A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
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
Name | Description |
---|---|
vso.work | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Examples
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=5.0
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=5.0
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
}
Definitions
Name | Description |
---|---|
Reporting |
Return all the fields in work item revisions, including long text fields which are not returned by default |
Reporting |
ReportingRevisionsExpand
Return all the fields in work item revisions, including long text fields which are not returned by default
Name | Type | Description |
---|---|---|
fields |
string |
|
none |
string |
ReportingWorkItemRevisionsBatch
Name | Type | Description |
---|---|---|
continuationToken |
string |
|
isLastBatch |
boolean |
|
nextLink |
string |
|
values |
string[] |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for