如何获取Azure Devops项目的所有工作项(史诗,功能,问题,任务,测试用例,用户故事等)?

时间:2019-01-22 05:58:54

标签: python api azure-devops azure-devops-rest-api

我试图获取所有工作项(史诗,功能,问题,任务,测试用例,用户案例等),然后使用Microsoft的azure devops python api(又名vsts)库对给定项目进行分类。

在work_item_tracking中,我找不到任何函数来获取 all 工作项或根据其类型获取 all 工作项。

是否已经存在用于获取所有我找不到的工作项的功能,或者我应该编写WIQL查询以获取所需的数据?

3 个答案:

答案 0 :(得分:2)

我正在使用此documentation来做到这一点。

有了Wiql,我们可以查询Azure Devops或TFS,我使用Postman来处理它。 第一步是在网址后使用de: https://dev.azure.com/ {organization} / {projectId} / _ apis / wit / wiql?api-version = 5.0

Okey下一步是通过wiql创建查询,为此,我们将需要使用json发送查询:

admin.database().ref(somethingWhichIsUndefined).remove()

如果请求是200 OK,您将获得一个包含所有Works项目的json。

我的结果: Result of my query

答案 1 :(得分:1)

首先,我没有使用python库,但是我可以告诉您必须使用哪些API。

有一个API可以检索所有work items。这只是具有所有工作项类型和属性的JSON对象。请注意,每个请求仅限于200个工作项。如果需要更多工作项,则必须编写WIQL查询。

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems?ids={ids}&api-version=5.0-preview.3

我个人建议您使用WIQL查询从Azure DevOps检索数据。它非常灵活,可以在任何情况下使用。

在这里您可以找到有关WIQL queries

的更多信息

在这里您可以找到有关Azure DevOps Rest API for WIQL Queries

的详细信息

答案 2 :(得分:1)

  

是否已经存在用于获取所有我找不到的工作项的功能,或者我应该编写WIQL查询以获取所需的数据?

你是对的。我们可以使用编写WIQL查询来获取系统ID,然后可以根据system.Ids查询工作项。以下是使用python代码获取所有工作项的演示代码。

from vsts.vss_connection import VssConnection
from msrest.authentication import BasicAuthentication
import json
from vsts.work_item_tracking.v4_1.models.wiql import Wiql

def emit(msg, *args):
print(msg % args)

def print_work_item(work_item):
    emit(
        "{0} {1}: {2}".format(
            work_item.fields["System.WorkItemType"],
            work_item.id,
            work_item.fields["System.Title"],
        )
    )

personal_access_token = 'YourPATToken'
organization_url = 'https://dev.azure.com/YourorgName'
# Create a connection to the org
credentials = BasicAuthentication('', personal_access_token)
connection = VssConnection(base_url=organization_url, creds=credentials)
wiql = Wiql(
        query="""select [System.Id] From WorkItems """
    )

wit_client = connection.get_client('vsts.work_item_tracking.v4_1.work_item_tracking_client.WorkItemTrackingClient')
wiql_results = wit_client.query_by_wiql(wiql).work_items
if wiql_results:
        # WIQL query gives a WorkItemReference with ID only
        # => we get the corresponding WorkItem from id
        work_items = (
            wit_client.get_work_item(int(res.id)) for res in wiql_results
        )
        for work_item in work_items:
            print_work_item(work_item)

有关更多演示代码,您可以参考此link