Reporting Work Item Revisions - Read Reporting Revisions Post

Reference

Service:: Work Item Tracking

API Version:: 5.0

Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?api-version=5.0

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?continuationToken={continuationToken}&startDateTime={startDateTime}&$expand={$expand}&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		ReportingRevisionsExpand
continuationToken	query		string	Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
startDateTime	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.

Request Body

Name	Type	Description
fields	string[]	A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
includeDeleted	boolean	Include deleted work item in the result.
includeIdentityRef	boolean	Return an identity reference instead of a string value for identity fields.
includeLatestOnly	boolean	Include only the latest version of a work item, skipping over all previous revisions of the work item.
includeTagRef	boolean	Include tag reference instead of string value for System.Tags field
types	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	ReportingWorkItemRevisionsBatch	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

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?continuationToken=813;350;1&api-version=5.0

{
  "types": [
    "Bug",
    "Task",
    "Product Backlog Item"
  ],
  "fields": [
    "System.WorkItemType",
    "System.Title",
    "System.AreaPath"
  ],
  "includeIdentityRef": true
}

Sample Response

Status code:: 200

{
  "values": [
    {
      "id": 3,
      "rev": 8,
      "fields": {
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Technician can submit invoices on Windows Phone"
      }
    }
  ],
  "nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=842;5;3&api-version=2.0",
  "isLastBatch": true
}

Definitions

Name	Description
ReportingRevisionsExpand
ReportingWorkItemRevisionsBatch
ReportingWorkItemRevisionsFilter

ReportingRevisionsExpand

Name	Type	Description
fields	string
none	string

ReportingWorkItemRevisionsBatch

Name	Type	Description
continuationToken	string
isLastBatch	boolean
nextLink	string
values	string[]

ReportingWorkItemRevisionsFilter

Name	Type	Description
fields	string[]	A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
includeDeleted	boolean	Include deleted work item in the result.
includeIdentityRef	boolean	Return an identity reference instead of a string value for identity fields.
includeLatestOnly	boolean	Include only the latest version of a work item, skipping over all previous revisions of the work item.
includeTagRef	boolean	Include tag reference instead of string value for System.Tags field
types	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.