Azure DevOps Wiql API 向 Response workItems 添加字段
Azure DevOps Wiql API add fields to Response workItems
我正在寻找一种方法(或查询)来在此查询的响应中添加 workItem 字段:
{
"query": "Select [System.Id], [System.Title] From WorkItems Where [System.WorkItemType] = 'Task' OR [System.WorkItemType] = 'Bug'"
}
当前响应:
{
"queryType": "flat",
"queryResultType": "workItem",
"asOf": "2020-08-17T15:13:32.75Z",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/.../_apis/wit/fields/System.Id"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/..._apis/wit/fields/System.Title"
}
],
"workItems": [
{
"id": 27,
"url": "https://dev.azure.com/.../_apis/wit/workItems/27"
},
{
"id": 44,
"url": "https://dev.azure.com/.../_apis/wit/workItems/44"
}
]
}
我需要扩展找到的每个工作项的字段,就像我会做一个 GET workitems API request,即使它可能 ?$expand=relations
这将是我对 WorkItems 的预期输出
预期响应:
{
"queryType": "flat",
"queryResultType": "workItem",
"asOf": "2020-08-17T15:13:32.75Z",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/.../_apis/wit/fields/System.Id"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/.../_apis/wit/fields/System.Title"
}
],
"workItems": [
{
"id": 27,
"rev": 22,
"fields": {
"System.AreaPath": "Cloud",
"System.TeamProject": "Cloud",
"System.IterationPath": "Cloud\Sprint 6",
"System.WorkItemType": "Task",
"System.State": "Closed",
"System.Reason": "Completed",
"System.AssignedTo": {...},
"System.CreatedDate": "2020-02-24T15:52:08.867Z",
"System.CreatedBy": {...},
"System.ChangedDate": "2020-06-24T14:48:26.593Z",
"System.ChangedBy": {...},
"System.CommentCount": 6,
"System.Title": "Add XCAL import support to AAT3 framework and GUI",
"Microsoft.VSTS.Common.StateChangeDate": "2020-06-24T14:48:26.593Z",
"Microsoft.VSTS.Common.ActivatedDate": "2020-06-03T00:47:20.397Z",
"Microsoft.VSTS.Common.ActivatedBy": {...},
"Microsoft.VSTS.Common.ClosedDate": "2020-06-24T14:48:26.593Z",
"Microsoft.VSTS.Common.ClosedBy": {...},
"Microsoft.VSTS.Common.Priority": 2,
"Microsoft.VSTS.Common.ValueArea": "Business",
"WEF_DA224280DD46429CA75C96DC1082D816_Kanban.Column": "New",
"WEF_DA224280DD46429CA75C96DC1082D816_Kanban.Column.Done": false,
"System.Description": "...",
"System.Parent": 45
},
"relations": [...],
"_links": {...},
"url": "...workItems/27"
},
{
"id": 44,
...
}
]
}
恐怕WIQL Rest API 无法 return详细的工作项信息。
但是您可以使用 WIQL 获取工作项 ID 并将这些 ID 发送到 Work item -List。在这种情况下,您可以获得工作项信息。
这是一个 PowerShell 脚本示例:
$token = "PAT"
$url="https://dev.azure.com/Organizationname/_apis/wit/wiql?api-version=5.1"
$token = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes(":$($token)"))
$JSON = @'
{
"query": "SELECT [System.Id], [System.WorkItemType], [System.State],[System.AreaPath],[System.Tags],[System.CommentCount],[System.ChangedDate] FROM workitems WHERE[System.Id] IN(@follows) AND [System.TeamProject] = 'Azure' AND [System.State] <> '' ORDER BY [System.ChangedDate] DESC"
}
'@
$response = Invoke-RestMethod -Uri $url -Headers @{Authorization = "Basic $token"} -Method Post -Body $JSON -ContentType application/json
$listOfTasks = New-Object Collections.Generic.List[String]
ForEach( $workitem in $response.workItems ) {
$listOfTasks.Add($workitem.id)
}
$listOfTasks = $listOfTasks -join ','
$listOfTasks
$url1="https://dev.azure.com/Organizationname/ProjectName/_apis/wit/workitems?ids=$listOfTasks" +"&" + "`$expand" + "=all&api-version=5.1"
$response1 = Invoke-RestMethod -Uri $url1 -Headers @{Authorization = "Basic $token"} -Method Get
Write-Host "result = $($response1 | ConvertTo-Json -Depth 100)"
解释:
第一部分是获取wiql输出的workitem id
第二部分是在工作项列表中添加工作项id列表api获取所有工作项的具体信息
结果如下:
我正在寻找一种方法(或查询)来在此查询的响应中添加 workItem 字段:
{
"query": "Select [System.Id], [System.Title] From WorkItems Where [System.WorkItemType] = 'Task' OR [System.WorkItemType] = 'Bug'"
}
当前响应:
{
"queryType": "flat",
"queryResultType": "workItem",
"asOf": "2020-08-17T15:13:32.75Z",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/.../_apis/wit/fields/System.Id"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/..._apis/wit/fields/System.Title"
}
],
"workItems": [
{
"id": 27,
"url": "https://dev.azure.com/.../_apis/wit/workItems/27"
},
{
"id": 44,
"url": "https://dev.azure.com/.../_apis/wit/workItems/44"
}
]
}
我需要扩展找到的每个工作项的字段,就像我会做一个 GET workitems API request,即使它可能 ?$expand=relations
这将是我对 WorkItems 的预期输出 预期响应:
{
"queryType": "flat",
"queryResultType": "workItem",
"asOf": "2020-08-17T15:13:32.75Z",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/.../_apis/wit/fields/System.Id"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/.../_apis/wit/fields/System.Title"
}
],
"workItems": [
{
"id": 27,
"rev": 22,
"fields": {
"System.AreaPath": "Cloud",
"System.TeamProject": "Cloud",
"System.IterationPath": "Cloud\Sprint 6",
"System.WorkItemType": "Task",
"System.State": "Closed",
"System.Reason": "Completed",
"System.AssignedTo": {...},
"System.CreatedDate": "2020-02-24T15:52:08.867Z",
"System.CreatedBy": {...},
"System.ChangedDate": "2020-06-24T14:48:26.593Z",
"System.ChangedBy": {...},
"System.CommentCount": 6,
"System.Title": "Add XCAL import support to AAT3 framework and GUI",
"Microsoft.VSTS.Common.StateChangeDate": "2020-06-24T14:48:26.593Z",
"Microsoft.VSTS.Common.ActivatedDate": "2020-06-03T00:47:20.397Z",
"Microsoft.VSTS.Common.ActivatedBy": {...},
"Microsoft.VSTS.Common.ClosedDate": "2020-06-24T14:48:26.593Z",
"Microsoft.VSTS.Common.ClosedBy": {...},
"Microsoft.VSTS.Common.Priority": 2,
"Microsoft.VSTS.Common.ValueArea": "Business",
"WEF_DA224280DD46429CA75C96DC1082D816_Kanban.Column": "New",
"WEF_DA224280DD46429CA75C96DC1082D816_Kanban.Column.Done": false,
"System.Description": "...",
"System.Parent": 45
},
"relations": [...],
"_links": {...},
"url": "...workItems/27"
},
{
"id": 44,
...
}
]
}
恐怕WIQL Rest API 无法 return详细的工作项信息。
但是您可以使用 WIQL 获取工作项 ID 并将这些 ID 发送到 Work item -List。在这种情况下,您可以获得工作项信息。
这是一个 PowerShell 脚本示例:
$token = "PAT"
$url="https://dev.azure.com/Organizationname/_apis/wit/wiql?api-version=5.1"
$token = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes(":$($token)"))
$JSON = @'
{
"query": "SELECT [System.Id], [System.WorkItemType], [System.State],[System.AreaPath],[System.Tags],[System.CommentCount],[System.ChangedDate] FROM workitems WHERE[System.Id] IN(@follows) AND [System.TeamProject] = 'Azure' AND [System.State] <> '' ORDER BY [System.ChangedDate] DESC"
}
'@
$response = Invoke-RestMethod -Uri $url -Headers @{Authorization = "Basic $token"} -Method Post -Body $JSON -ContentType application/json
$listOfTasks = New-Object Collections.Generic.List[String]
ForEach( $workitem in $response.workItems ) {
$listOfTasks.Add($workitem.id)
}
$listOfTasks = $listOfTasks -join ','
$listOfTasks
$url1="https://dev.azure.com/Organizationname/ProjectName/_apis/wit/workitems?ids=$listOfTasks" +"&" + "`$expand" + "=all&api-version=5.1"
$response1 = Invoke-RestMethod -Uri $url1 -Headers @{Authorization = "Basic $token"} -Method Get
Write-Host "result = $($response1 | ConvertTo-Json -Depth 100)"
解释:
第一部分是获取wiql输出的workitem id
第二部分是在工作项列表中添加工作项id列表api获取所有工作项的具体信息
结果如下: