通过 REST API 的 VSTS 工作项列表

2024-04-22

如何使用 REST API 从 VSTS 获取工作项列表?

根据文档 https://www.visualstudio.com/docs/integrate/api/wit/work-items, the ids参数是可选的,但是当我省略它时,我得到一个404错误。 如果我添加ids参数,我可以获取项目。

请求失败:
GET https://{account}.visualstudio.com/DefaultCollection/_apis/wit/workitems?api-version=1.0

成功请求:
GET https://{account}.visualstudio.com/DefaultCollection/_apis/wit/workitems?ids=252&api-version=1.0

两者的身份验证相同。

要解决的完整问题是:获取特定 VSTS 项目中的所有功能


关键是要使用WIQLAPI 的一部分,而不是工作项。 例如,要获取某种类型的工作项的平面列表,请使用以下命令:https://www.visualstudio.com/en-us/docs/integrate/api/wit/wiql#a-flat-query https://www.visualstudio.com/en-us/docs/integrate/api/wit/wiql#a-flat-query

PowerShell 中的示例(显示所有处于关闭状态的用户故事):

    # using env vars passed from VSTS build
    $collectionuri = $Env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI
    $token = $Env:SYSTEM_ACCESSTOKEN # need to configure build to allow passing OAuth tokens

    $basicAuth = "{0}:{1}"-f "ivan-the-terrible", $token
    $basicAuth = [System.Text.Encoding]::UTF8.GetBytes($basicAuth)
    $basicAuth = [System.Convert]::ToBase64String($basicAuth)
    $headers = @{Authorization=("Basic {0}"-f $basicAuth)}

    $WorkItemType = 'User Story'

    $url = $collectionuri + 'DefaultCollection/_apis/wit/wiql?api-version=1.0'

    $WIQL_query = "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = '" + $WorkItemType + "' AND [State] = 'Closed' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
    $body = @{ query = $WIQL_query }
    $bodyJson=@($body) | ConvertTo-Json

    $response = Invoke-RestMethod -Uri $url -headers $headers -Method Post -ContentType "application/json" -Body $bodyJson

    $workitems = $response.workItems

    Write-Host "Found" $workitems.Count "work items of type:" $WorkItemType
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

通过 REST API 的 VSTS 工作项列表 的相关文章

随机推荐