python - 如何检索附加到工作项的 wiki 链接

Question

我正在尝试使用 azure-devops python 包从 Azure DevOps 中提取 wiki 链接。使用 WIQL 是否可行？检索项目到项目的链接可以这样完成：

        SELECT * FROM workitemLinks 
        WHERE (Source.[System.AreaPath] Under 'devOpsTesting\\testArea')
        AND ([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward')
        AND (Source.[System.Id] = 3)  
        ORDER BY [System.Id]
        MODE (Recursive)
    

wiki 链接是否有类似的解决方案，如果没有，如何检索它们？

标签： pythonazure-devopswiql

Answer 1

我们无法通过 WIQL 查询列出 wiki 链接的工作链接。如果链接不包含工作项，我们就无法得到我们想要的结果。

作为测试结果，我发现如果我们将 wiki 链接到工作项，字段的值External Link Count将大于0.

作为一种解决方法，我们可以使用REST API列出所有External Link Count大于0.

REST API

POST https://dev.azure.com/{Org name}/{Project name}/{Team name}/_apis/wit/wiql?api-version=6.0

请求正文：

 {"query": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.TeamProject] = @project and [System.WorkItemType] = 'User Story' AND [External Link Count] > '0' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}

现在，我们可以列出工作项 ID。

结果：

然后我们通过REST API检查工作项详细信息。

GET https://dev.azure.com/{Org name}/{Project name}/_apis/wit/workitems/{Work item ID}?$expand=all&api-version=6.1-preview.3

我们需要注意这个字段relations.attributes.name，如果工作项链接wiki，我们可以通过这个字段检查它。

结果：

更新1

检索附加到工作项的 wiki 链接

通过 REST API 和 power shell 列出工作项 ID。

电源外壳脚本：

$connectionToken="{PAT}"
$base64AuthInfo= [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes(":$($connectionToken)"))
$WorkItemQueryURL = "https://dev.azure.com/{Org name}/{project}/{team name}/_apis/wit/wiql?api-version=6.0" 

$body =@"
{
  "query": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.TeamProject] = @project and [System.WorkItemType] = 'User Story' AND [External Link Count] > '0' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}
"@
$WorkItem = Invoke-RestMethod -Uri $WorkItemQueryURL -ContentType "application/json" -Body $body -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)} -Method POST

#Write-host $WorkItem.workItems.id



ForEach ($ID in $WorkItem.workItems.id)
{
 
 $WorkItemInfoURL = "https://dev.azure.com/{org name}/{project name}/_apis/wit/workitems/$($ID)?" + "$" + "expand=1&api-version=6.1-preview.3" 
 $WorkItemInfo = Invoke-RestMethod -Uri $WorkItemInfoURL -Headers @{authorization = "Basic $base64AuthInfo"} -Method Get

 #Write-host   $WorkItemInfo.relations.attributes.name

 if ($WorkItemInfo.relations.attributes.name -eq "Wiki Page"){  
  Write-host $ID
 }

}

结果：

更新2

休息API：

GET https://dev.azure.com/{Org name}/{project name}/_apis/wit/workitems/{wok item ID}?$expand=all&api-version=6.1-preview.3

结果：

我们可以通过响应 url 链接获取 wiki 名称。