Reporting Work Item Revisions - Read Reporting Revisions Post

参考

服务:: Work Item Tracking

API 版本:: 7.1

获取一批工作项修订。如果字段列表足够大，并且可能会超过长度限制运行 URL，可以使用此请求。

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

具有可选参数:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?continuationToken={continuationToken}&startDateTime={startDateTime}&$expand={$expand}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。
$expand	query		ReportingRevisionsExpand
continuationToken	query		string	指定要从中启动批处理的水印。省略此参数以获取第一批修订。
startDateTime	query		string (date-time)	用作修订起点的日期/时间，所有修订都将在此日期/时间之后发生。不能与“水印”参数结合使用。

请求正文

名称	类型	说明
fields	string[]	在工作项修订中返回的字段列表。省略此参数以获取所有可报告字段。
includeDeleted	boolean	在结果中包含已删除的工作项。
includeIdentityRef	boolean	返回标识引用，而不是标识字段的字符串值。
includeLatestOnly	boolean	仅包括工作项的最新版本，跳过工作项的所有以前的修订。
includeTagRef	boolean	包括标记引用而不是 System.Tags 字段的字符串值
types	string[]	用于将结果筛选为特定工作项类型的类型列表。省略此参数以获取所有工作项类型的工作项修订。

响应

名称	类型	说明
200 OK	ReportingWorkItemRevisionsBatch	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.work	授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

示例请求

HTTP

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

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

示例响应

状态代码:: 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
}

定义

名称	说明
ReportingRevisionsExpand
ReportingWorkItemRevisionsBatch
ReportingWorkItemRevisionsFilter	该类表示报告工作项修订文件程序。

ReportingRevisionsExpand

枚举

值	说明
fields	向响应添加字段。
none	默认行为。

ReportingWorkItemRevisionsBatch

Object

名称	类型	说明
continuationToken	string	ContinuationToken 充当水印。查询大型结果时使用。
isLastBatch	boolean	如果它是最后一批，则返回“true”;否则返回“false”。
nextLink	string	工作项的下一个链接。
values	string[] (T)	rel、sourceId、TargetId、ChangedDate、isActive 等值。

ReportingWorkItemRevisionsFilter