Azure DevOps API添加自定义页面字段失败，页面空白问题排查

你的代码主要存在几个格式和结构问题，导致字段无法在自定义页面中显示：

1. 集合类型格式错误 #

API要求sections、groups、controls必须是数组类型（用@()包裹），但你当前用的是单个哈希表（@{}）。Azure DevOps无法识别单个对象作为集合，因此无法加载控件。

2. 控件缺少必要类型指定 #

虽然部分字段可以自动识别控件类型，但显式设置controlType = "FieldControl"能确保字段被正确渲染为输入控件。

3. 未定义apiVersion变量 #

代码中引用的$apiVersion未在函数内定义，可能导致URI拼接错误，建议在函数内明确指定版本参数。

4. order字段建议设置数值 #

order设为null可能导致布局排序异常，建议为页面、章节、组和控件设置合理的排序数值（如0、1等）。

修正后的完整代码 #

function addWorkItemFieldPage {
[CmdletBinding()] param (
    [Parameter(Mandatory)] [string]    $organization,
    [Parameter(Mandatory)] [string]    $processId,
    [Parameter(Mandatory)] [string]    $witRefName,
    [Parameter(Mandatory)] [Object]    $info,
    [Parameter(Mandatory)] [hashtable] $header
)

# 明确指定API版本
[string] $apiVersion = "api-version=7.1"
[string] $uri = "https://dev.azure.com/{0}/_apis/work/processes/{1}/workItemTypes/{2}/layout/pages?{3}" -f $organization, $processId, $witRefName, $apiVersion

[string] $body = @{
    sections = @( # 改为数组格式
        @{ 
            id = "Section1"
            groups = @( # 改为数组格式
                @{
                    id = $info.label
                    controls = @( # 改为数组格式
                        @{
                            id = $info.refName
                            label = $info.label
                            order = 0 # 设置排序数值
                            height = $null
                            visible = $true
                            readOnly = $false
                            controlType = "FieldControl" # 明确指定控件类型
                            isContribution = $false
                        }
                    )
                    overridden = $false
                    visible = $true
                    order = 0 # 设置组排序
                }
            )
            overridden = $false
            visible = $true
            order = 0 # 设置章节排序
        }
    )
    label = $info.page
    order = 0 # 设置页面排序
    visible = $true
    locked = $false
    pageType = 1
} | ConvertTo-Json -Depth 3

Write-Host $uri
try {
    Invoke-RestMethod -Uri $uri -Method Post -Headers $header -Body $body -ContentType application/json
} catch {
    Get-Error
    throw
}
}

验证步骤 #

1. 确保$info对象包含refName（字段引用名）、label（字段显示名）、page（页面名称）三个属性。
2. 调用函数时，确认$header包含有效的Azure DevOps认证信息（如PAT令牌）。
3. 执行后，打开对应工作项类型的布局，检查自定义页面是否已显示目标字段。

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