如何通过Azure DevOps API获取指定项目团队的工作项类型列表

问题描述 #

我需要拿到Azure DevOps里指定项目下某支团队能使用的工作项类型（比如Epic、Task、Feature这类）。试了Work Items - List API，但它必须指定工作项ID，没法直接获取全部；又调用了WIQL的POST接口：

POST https://dev.azure.com/{org}/{project}/{Team}/_apis/wit/wiql?api-version=5.1

请求体是：

{"query": "Select [System.WorkItemType] From WorkItems"}

但返回结果只有工作项ID列表，没拿到想要的工作项类型列表，求解决办法。

解决方案 #

最优方式：直接调用工作项类型列表API

别绕WIQL了，Azure DevOps有专门的API可以直接获取指定团队（或项目）配置的可用工作项类型，调用这个GET接口就行：

GET https://dev.azure.com/{org}/{project}/{team}/_apis/wit/workitemtypes?api-version=7.1-preview.3

这个接口会直接返回该团队所有可用的工作项类型，包含名称、描述、颜色等完整信息，完全匹配你的需求，而且效率高。

为什么之前的WIQL方法没得到预期结果？

你用的WIQL查询Select [System.WorkItemType] From WorkItems，本质是定位符合条件的工作项，返回的是工作项ID集合——WIQL的设计逻辑就是先找到工作项，要获取具体字段值，还得把这些ID传给Work Items - List API（用ids参数批量传入），同时指定fields=System.WorkItemType来提取类型。

但这种方法有两个问题：

• 效率低，需要两次API调用
• 只能拿到当前已经存在的工作项的类型，没法获取团队配置中允许创建但还没被使用的类型

如果非要用这种方式，步骤是：

1. 用WIQL拿到工作项ID列表
2. 调用批量查询接口：

   GET https://dev.azure.com/{org}/{project}/_apis/wit/workitems?ids={id1},{id2,...}&fields=System.WorkItemType&api-version=7.1-preview.3
   

3. 从返回结果中提取System.WorkItemType字段，去重后得到类型列表

但显然直接调用工作项类型API的方法更靠谱。

内容的提问来源于stack exchange，提问作者Karan S