rest - 如何使用 VSO/VSTS Rest API 执行自定义查询？

Question

我希望得到一些帮助，使用 REST API 执行自定义 VSO 查询。但是我在构建 URL 时遇到了麻烦。我一直在使用以下文档来构建我想要的东西。

https://www.visualstudio.com/en-us/integrate/api/wit/wiql

我的问题是我不确定如何或在哪里存储它自己的查询。

https://{instance}/defaultcollection/[{project}/]_apis/wit/wiql?api-version={version}

给出的例子是

https://fabrikam.visualstudio.com/DefaultCollection/Fabrikam-Fiber-Git/_apis/wit/wiql?api-version=1.0

但这并没有显示存储查询的方式或位置。

我已经能够使用存储的查询执行相同的查询，但是，结果不会返回我在 VSO 的查询中设置的列。

Answer 1

用于执行查询的其余端点是一个 POST 方法，并期望 JSON 正文包含一个 key query。

因此，要执行自定义查询，您将执行一个 POST 调用，https://{instance}/defaultcollection/[{project}/]_apis/wit/wiql?api-version={version}并将content-type标头设置为application/json以下格式的请求正文。

{
  "query": string
}

例子：

POST https://fabrikam.visualstudio.com/DefaultCollection/Fabrikam-Fiber-Git/_apis/wit/wiql?api-version=1.0
Content-Type: application/json

身体：

{
  "query": "Select [System.WorkItemType],[System.Title],[System.State],[Microsoft.VSTS.Scheduling.Effort],[System.IterationPath] FROM WorkItemLinks WHERE Source.[System.WorkItemType] IN GROUP 'Microsoft.RequirementCategory' AND Target.[System.WorkItemType] IN GROUP 'Microsoft.RequirementCategory' AND Target.[System.State] IN ('New','Approved','Committed') AND [System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward' ORDER BY [Microsoft.VSTS.Common.BacklogPriority] ASC,[System.Id] ASC MODE (Recursive, ReturnMatchingChildren)"
}