使用ADO API reporting/workitemrevisions未返回HTML字段问题咨询
问题分析与解决
核心原因:
wit/reporting/workitemrevisions这类报告API以高效批量获取结构化工作项数据为设计目标,默认会过滤体积较大的HTML富文本字段(如System.Description、Microsoft.VSTS.Common.AcceptanceCriteria),这是API的内置行为,并非权限问题或配置遗漏。API行为差异:
wit/workItems/{workitemNumber}是单个工作项详情接口,设计初衷是返回工作项的完整信息,因此会包含所有类型字段(包括HTML富文本),这就是两个API返回结果不同的根本原因。解决方案:若需在批量获取修订记录时包含这些HTML字段,只需在API请求中显式指定目标字段,在原URL后追加
fields参数即可:https://{instance}/{proj}/_apis/wit/reporting/workitemrevisions?api-version=4.1&types=User Story&fields=System.Description,Microsoft.VSTS.Common.AcceptanceCriteria也可使用
fields=*返回全部字段,但会降低请求性能,建议按需指定。关于“此前正常现在失效”:大概率是ADO后端对该API的默认返回字段规则做了调整,之前可能默认包含部分富文本字段,现在改为默认排除,因此需要显式声明才能获取。
内容的提问来源于stack exchange,提问作者Yousuf kamal
相关产品推荐
相关产品推荐

