Work Items - Get Work Items Batch

参考

Service:: Work Item Tracking

API Version:: 6.1-preview.1

获取工作项 ID 列表的工作项 (最大 200)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsbatch?api-version=6.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“6.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
$expand	WorkItemExpand	工作项属性的展开参数。可能的选项包括 { None， Relations， Fields， Links， All }
asOf	string	AsOf UTC 日期时间字符串
errorPolicy	WorkItemErrorPolicy	用于控制批量获取工作项请求中的错误策略的标志。可能的选项为 {Fail， Omit}。
fields	string[]	请求的字段
ids	integer[]	请求的工作项 ID

响应

名称	类型	说明
200 OK	WorkItem[]	成功的操作

安全性

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 list of work items for specific fields

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/workitemsbatch?api-version=6.1-preview.1

{
  "ids": [
    297,
    299,
    300
  ],
  "fields": [
    "System.Id",
    "System.Title",
    "System.WorkItemType",
    "Microsoft.VSTS.Scheduling.RemainingWork"
  ]
}

Sample Response

Status code:: 200

{
  "count": 3,
  "value": [
    {
      "id": 297,
      "rev": 1,
      "fields": {
        "System.Id": 297,
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Customer can sign in using their Microsoft Account"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
    },
    {
      "id": 299,
      "rev": 7,
      "fields": {
        "System.Id": 299,
        "System.WorkItemType": "Task",
        "System.Title": "JavaScript implementation for Microsoft Account",
        "Microsoft.VSTS.Scheduling.RemainingWork": 4
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 300,
      "rev": 1,
      "fields": {
        "System.Id": 300,
        "System.WorkItemType": "Task",
        "System.Title": "Unit Testing for MSA login",
        "Microsoft.VSTS.Scheduling.RemainingWork": 3
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    }
  ]
}

定义

名称	说明
ReferenceLinks	表示 REST 引用链接集合的类。
WorkItem	描述工作项。
WorkItemBatchGetRequest	描述获取一组工作项的请求
WorkItemCommentVersionRef	表示对工作项注释的特定版本的引用。
WorkItemErrorPolicy	用于控制批量获取工作项请求中的错误策略的标志。可能的选项为 {Fail， Omit}。
WorkItemExpand	工作项属性的展开参数。可能的选项包括 { None， Relations， Fields， Links， All }
WorkItemRelation

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

WorkItem

描述工作项。

名称	类型	说明
_links	ReferenceLinks	将引用链接到相关的 REST 资源。
commentVersionRef	WorkItemCommentVersionRef	引用此修订版中添加/编辑/删除的特定版本的注释。
fields	object	工作项的字段和值的映射。
id	integer	工作项 ID。
relations	WorkItemRelation[]	工作项的关系。
rev	integer	工作项的修订号。
url	string

WorkItemBatchGetRequest

描述获取一组工作项的请求

名称	类型	说明
$expand	WorkItemExpand	工作项属性的展开参数。可能的选项包括 { None， Relations， Fields， Links， All }
asOf	string	AsOf UTC 日期时间字符串
errorPolicy	WorkItemErrorPolicy	用于控制批量获取工作项请求中的错误策略的标志。可能的选项为 {Fail， Omit}。
fields	string[]	请求的字段
ids	integer[]	请求的工作项 ID

WorkItemCommentVersionRef

表示对工作项注释的特定版本的引用。

名称	类型	说明
commentId	integer	分配给注释的 ID。
createdInRevision	integer	[内部]最初添加此注释的工作项修订。
isDeleted	boolean	[内部]指定是否删除注释。
text	string	[内部]批注的文本。
url	string
version	integer	版本号。

WorkItemErrorPolicy

用于控制批量获取工作项请求中的错误策略的标志。可能的选项为 {Fail， Omit}。

名称	类型	说明
fail	string	失败工作错误策略。
omit	string	省略工作错误策略。

WorkItemExpand

工作项属性的展开参数。可能的选项包括 { None， Relations， Fields， Links， All }

名称	类型	说明
all	string	展开全部。
fields	string	字段工作项展开。
links	string	链接工作项展开。
none	string	默认行为。
relations	string	关系工作项展开。

WorkItemRelation

名称	类型	说明
attributes	object	链接属性的集合。
rel	string	关系类型。
url	string	链接 URL。

Share via