java - 如何在 tfs Java sdk 中查询链接的工作项
问题描述
如何在 TFS java sdk 中查询链接的工作项。下面是从 tfs 查询正常工作项的代码:
public static void main(final String[] args) {
final TFSTeamProjectCollection tpc = SnippetSettings.connectToTFS();
final Project project = tpc.getWorkItemClient().getProjects().get(SnippetSettings.PROJECT_NAME);
final WorkItemClient workItemClient = project.getWorkItemClient();
// Define the WIQL query.
final String wiqlQuery = "Select ID, Title from WorkItems where (State = 'Active') order by Title"; //$NON-NLS-1$
// Run the query and get the results.
final WorkItemCollection workItems = workItemClient.query(wiqlQuery);
System.out.println("Found " + workItems.size() + " work items."); //$NON-NLS-1$ //$NON-NLS-2$
System.out.println();
// Write out the heading.
System.out.println("Query: " + wiqlQuery); //$NON-NLS-1$
System.out.println();
System.out.println("ID\tTitle"); //$NON-NLS-1$
// Output the results of the query.
final int maxToPrint = 20;
for (int i = 0; i < workItems.size(); i++) {
if (i >= maxToPrint) {
System.out.println("[...]"); //$NON-NLS-1$
break;
}
final WorkItem workItem = workItems.getWorkItem(i);
System.out.println(workItem.getID() + "\t" + workItem.getTitle()); //$NON-NLS-1$
}
}
使用上面的代码运行链接的工作项查询时,我收到一条错误消息:
com.microsoft.tfs.core.clients.workitem.exceptions.ValidationException: TF248021: You have specified a query string that is not valid when you use the query method for a flat list of work items. You cannot specify a parameterized query or a query string for linked work items with the query method you specified.
解决方案
当您对平面查询执行 RunQuery() 时,您将获得成功的响应。但是,如果您对链接查询(树或单跳WIQL)执行 RunQuery(),您将看到此错误消息。
要执行链接查询,您必须在 Query 类上使用RunLinkQuery() 方法而不是 RunQuery()。这将返回一个 WorkItemLinkInfo 对象数组,其中包含以下字段:SourceId、TargetId、LinkTypeId 和 IsLocked。
下面是一个树查询的例子:
SELECT [System.Id], [System.State], [System.WorkItemType]
FROM WorkItemLinks
WHERE
(
Source.[System.TeamProject] = 'TFSTestProject'
AND Source.[System.WorkItemType] = 'Requirement'
AND Source.[System.State] NOT IN ('Proposed', 'Completed')
)
AND [System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward'
AND Target.[System.WorkItemType] <> ''
ORDER BY [System.Id] mode(Recursive)
下面是在 C# 中执行树查询的示例:
private List<WorkItemViewModel> GetWorkItemTree(string query)
{
var treeQuery = new Query(_workItemStore, query);
var links = treeQuery.RunLinkQuery();
var workItemIds = links.Select(l => l.TargetId).ToArray();
query = "SELECT * FROM WorkItems";
var flatQuery = new Query(_workItemStore, query, workItemIds);
var workItemCollection = flatQuery.RunQuery();
var workItemList = new List<WorkItemViewModel>();
for (int i = 0; i < workItemCollection.Count; i++)
{
var workItem = workItemCollection[i];
if (workItem.Type.Name == "Requirement")
{
var model = new WorkItemViewModel()
{
Id = workItem.Id,
RequestNo = workItem.Fields["MyCompany.RequestNumber"].Value.ToString(),
Title = workItem.Title,
WorkItemType = workItem.Fields["MyCompany.WorkItemType"].Value.ToString(),
Priority = workItem.Fields["MyCompany.Priority"].Value.ToString()
};
workItemList.Add(model);
}
else
{
switch (workItem.Type.Name)
{
case "Task":
var task = new TFSTask()
{
Name = workItem.Title,
Activity = workItem.Fields["MyCompany.Activity"].Value.ToString(),
Start = (DateTime?)workItem.Fields["MyCompany.ActivityStart"].Value,
Due = (DateTime?)workItem.Fields["MyCompany.ActivityFinish"].Value,
Status = workItem.State
};
workItemList.Last().Tasks.Add(task);
break;
case "Issue":
var issue = new TFSIssue()
{
Name = workItem.Title,
Created = workItem.CreatedDate,
Due = (DateTime?)workItem.Fields["MyCompany.ActivityDue"].Value,
Status = workItem.State
};
workItemList.Last().Issues.Add(issue);
break;
default:
break;
}
}
}
return workItemList;
}
有用的链接:
- https://github.com/prabuw/prabuw.github.io/blob/master/_posts/2012-09-18-retrieving-work-items-using-the-team-foundation-server-api.markdown
- https://blogs.msdn.microsoft.com/jsocha/2012/02/22/retrieving-tfs-results-from-a-tree-query/
顺便说一句,您还可以使用 TFS Rest api 来运行链接查询:
https://docs.microsoft.com/en-us/rest/api/vsts/wit/wiql/query%20by%20wiql
推荐阅读
- c++ - 继承的成员函数的意外输出
- python - 从 .ui 自动完成
- r - 通过 for-loop 绘制子图从最后一个循环创建图
- dataframe - 加入后是否会推送 dropDuplicates 和 select 操作,以防未选择任何内容?
- mysql - 数据库导出-导入中的垃圾数据使用相同的表排序规则
- c# - 返回值方法不使用try catch语句返回值
- loops - 在定期调用的函数中每隔一段时间重复某些内容的优雅方式
- sap - SAP for non SAPpers:变更文档是传输的集合,只是代码增量?
- javascript - Vue Js - 在单个 vue 组件中的多个 js 文件中拆分 methods.js
- mosquitto - 接收消息时如何确定ID客户端?