Azure DevOps API获取System.History字段返回不稳定问题咨询

System.History 不是工作项当前版本的持久化单值字段，工作项详情页展示的历史评论区内容，是后端动态聚合该工作项所有历史修订版本中的评论条目渲染生成的，不存在于工作项最新版本的字段存储中。
在getWorkItem接口的fields参数中指定拉取该字段时，接口没有内置稳定的聚合逻辑，才会出现随机返回undefined的情况，这不是调用参数错误，是该接口本身就不支持稳定返回这个字段的内容，无法通过调整传参解决。

直接放弃用getWorkItem拉取System.History的逻辑，改用专门的历史/评论接口获取数据，两种方案都可以稳定拿到全量评论，根据业务场景选即可：

方案1：拉取工作项全量修订记录提取评论 #

适合除了评论之外，还需要比对工作项历史字段变更（比如状态、标签的变更轨迹）的场景，调用getRevisions接口获取工作项所有版本的修订记录，遍历提取每个版本中的评论内容：

// 传入对应项目名、工作项ID拉取全量修订
const revisions = await witApi.getRevisions(workItemId, project);
const allCommentContents: string[] = [];
revisions.forEach(revision => {
  const historyContent = revision.fields?.["System.History"];
  if (typeof historyContent === 'string' && historyContent.trim()) {
    allCommentContents.push(historyContent.trim());
  }
});

返回的修订记录按提交时间升序排列，提取出的评论顺序和工作项页面展示顺序完全一致，可以直接和第三方平台拉取的数据做比对。

方案2：调用评论专用接口拉取数据 #

如果只需要评论数据，不需要其他字段的变更轨迹，直接调用评论专用接口，不需要遍历全量修订，性能更高：

const allComments: WorkItemTrackingInterfaces.Comment[] = [];
let continuationToken: string | undefined;
// 分页拉取全量评论，单页最大支持200条
do {
  const commentRes = await witApi.getComments(
    project,
    workItemId,
    undefined,
    continuationToken,
    200
  );
  if (commentRes.comments?.length) {
    allComments.push(...commentRes.comments);
  }
  continuationToken = commentRes.continuationToken;
} while (continuationToken);

// 提取评论内容、创建时间等信息做幂等比对
const commentList = allComments.map(comment => ({
  content: comment.text?.trim() || '',
  createTime: comment.createdDate
}));

这个接口返回的评论结构自带创建时间、创建人、评论ID属性，比对时不需要依赖纯文本匹配，准确率更高。

• 不要尝试通过给getWorkItem传expand参数拉取历史，WorkItemExpand的所有枚举值都不会触发System.History字段的稳定返回
• 做评论同步幂等判断时，不建议纯靠文本内容去重，可以在你追加的评论末尾加一段不会被前端渲染的HTML注释作为第三方记录的唯一标识，格式参考<!-- third_party_record_id: 平台侧唯一ID -->，比对时直接匹配这个标识即可，完全避免文本重复导致的重复追加问题。

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