如何通过Azure DevOps API隐藏工作项类型布局中的流程字段？

问题背景 #

尝试通过Azure DevOps API隐藏工作项类型布局中的字段，编写PowerShell脚本后请求返回404错误，但同URL的GET请求可正常响应；在工作项布局中能看到对应布尔值但无法修改，也找不到明确操作命令。

核心错误分析 #

1. API用途误解：你调用的Remove Work Item Type FieldAPI是用于从工作项类型中彻底移除字段，而非在布局中隐藏字段。要隐藏布局中的字段，需使用工作项类型布局更新API。
2. 脚本语法错误：原脚本中Invoke-RestMethod的-Method Deletec是拼写错误，应为Delete。
3. 认证方式冲突：若使用个人访问令牌（PAT），应使用Basic认证而非Bearer，PAT需转成Base64编码的:<PAT>格式。

正确解决方案 #

方案1：隐藏布局中的字段（符合需求） #

使用工作项类型布局的Patch API，修改字段的isHidden属性：

function hideFieldInLayout {
    param (
        $patToken,
        $organization,
        $processId,
        $witRefName,
        $fieldRefName
    )

    # 构造Basic认证头
    $authHeader = @{
        'Authorization' = "Basic $([Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$patToken")))"
        'Content-Type' = 'application/json-patch+json'
    }

    # 布局API的URL
    $uri = "https://dev.azure.com/$organization/_apis/work/processes/$processId/workItemTypes/$witRefName/layout?api-version=7.1"

    # 获取当前布局
    $currentLayout = Invoke-RestMethod -Uri $uri -Headers $authHeader -Method Get

    # 找到目标字段并设置isHidden为true
    $fieldToHide = $currentLayout.pages.flattenedFields | Where-Object { $_.referenceName -eq $fieldRefName }
    if ($fieldToHide) {
        $patchBody = @(
            @{
                op = "replace"
                path = "/pages/$($currentLayout.pages.IndexOf($fieldToHide.Page))/sections/$($fieldToHide.Section.Index)/fields/$($fieldToHide.Index)/isHidden"
                value = $true
            }
        ) | ConvertTo-Json

        # 发送Patch请求更新布局
        $result = Invoke-RestMethod -Uri $uri -Headers $authHeader -Method Patch -Body $patchBody
        Write-Host "字段已成功隐藏：$fieldRefName"
    }
    else {
        Write-Host "未找到目标字段：$fieldRefName"
    }
}

# 调用示例（替换为实际参数）
# hideFieldInLayout "你的PAT令牌" "组织名" "流程ID" "工作项类型引用名" "字段引用名"

方案2：修正原移除字段的脚本（若需彻底移除字段） #

如果需求是从工作项类型中移除字段，修正原脚本错误：

function removeWorkItemField {
    param ( $patToken, $organization, $processId, $witRefName, $fieldRefName )

    $headers = @{
        'Authorization' = "Basic $([Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$patToken")))"
        'Content-Type' = 'application/json'
    }
    $uri =  "https://dev.azure.com/$organization/_apis/work/processes/$processId/workItemTypes/$witRefName/fields/$fieldRefName?api-version=7.1"
    
    try {
        Invoke-RestMethod -Uri $uri -Method Delete -Headers $headers
        Write-Host "字段已成功从工作项类型移除：$fieldRefName"
    }
    catch {
        Write-Host "请求错误：$($_.Exception.Message)"
    }
}

# 调用逻辑（确保getProcessId等辅助函数正确返回对应ID）
if ( $args.Count -eq 5) {
    $token = $args[0]
    $organization = $args[1]
    $processId = getProcessId $token $organization $args[2]
    $witRefName = getWorkItemReferenceName $token $organization $processId $args[3]
    $fieldRefName = getWorkItemFieldReferenceName $token $organization $processId $witRefName $args[4]

    removeWorkItemField $token $organization $processId $witRefName $fieldRefName
}

关键注意事项 #

• 权限要求：需确保PAT拥有Processes (Read & Manage)权限。
• 引用名正确性：必须使用工作项类型和字段的引用名（而非显示名），否则会导致404错误。
• API版本：使用兼容的API版本（如7.1），避免版本不匹配问题。

内容的提问来源于stack exchange，提问作者Takadox et compagnie