如何从REST API动态取数并配置Azure DevOps工作项下拉选单？脚本调试失败

一、前置准备：配置Azure DevOps自定义下拉字段 #

• 先在项目的设置 > 工作项 > 字段中创建自定义下拉字段，记录下字段的引用名（格式通常是Custom.xxx，比如Custom.DynamicDropdown），这是脚本中必须用到的标识。
• 确保该字段已关联到你需要使用的工作项类型（如用户故事、任务）。

二、PowerShell脚本实现 #

以下脚本会从目标API拉取数据，全量更新Azure DevOps下拉字段的选项：

# 配置参数
$orgName = "你的组织名"
$projectName = "你的项目名"
$fieldRefName = "Custom.DynamicDropdown" # 替换为你的字段引用名
$apiUrl = "https://你的数据来源API地址"
$pat = "你的Azure DevOps PAT令牌" # 令牌需包含Work Item Tracking读写权限

# 拉取外部API数据
try {
    $externalData = Invoke-RestMethod -Uri $apiUrl -Method Get -ContentType "application/json"
    # 根据API返回结构调整，生成符合Azure DevOps要求的选项格式
    $options = $externalData | ForEach-Object {
        @{
            value = $_.Name # 替换为API返回的实际字段名
            label = $_.Name
        }
    }
} catch {
    Write-Error "拉取外部数据失败: $_"
    exit 1
}

# 构建字段更新请求体
$body = @{
    name = "DynamicDropdown" # 字段显示名
    type = "picklist"
    picklist = @{
        type = "picklistStatic"
        items = $options
    }
} | ConvertTo-Json -Depth 10

# 发送请求更新Azure DevOps字段
$adoApiEndpoint = "https://dev.azure.com/$orgName/$projectName/_apis/wit/fields/$fieldRefName?api-version=7.1-preview.3"
$authHeader = @{
    Authorization = "Basic " + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$pat"))
}

try {
    Invoke-RestMethod -Uri $adoApiEndpoint -Method Patch -Headers $authHeader -Body $body -ContentType "application/json"
    Write-Host "下拉选项更新成功"
} catch {
    Write-Error "更新Azure DevOps字段失败: $_"
}

注意事项 #

• PAT令牌需授予**Work Item Tracking (Write)**权限，否则会返回权限不足错误。
• 若外部API返回的数据结构不同，需调整$options的生成逻辑，确保每个选项包含value和label两个属性。
• 使用最新的API预览版本（如7.1-preview.3）避免兼容性问题。

三、Node.js脚本实现 #

如果偏好JavaScript，以下是基于axios的实现：

const axios = require('axios');

// 配置参数
const orgName = '你的组织名';
const projectName = '你的项目名';
const fieldRefName = 'Custom.DynamicDropdown';
const apiUrl = 'https://你的数据来源API地址';
const pat = '你的Azure DevOps PAT令牌';

// 编码PAT用于请求头
const encodedPat = Buffer.from(`:${pat}`).toString('base64');
const headers = {
    'Authorization': `Basic ${encodedPat}`,
    'Content-Type': 'application/json'
};

async function updateDropdown() {
    try {
        // 获取外部数据
        const { data } = await axios.get(apiUrl);
        const options = data.map(item => ({
            value: item.Name, // 匹配API返回的字段名
            label: item.Name
        }));

        // 构建更新请求体
        const updateBody = {
            name: 'DynamicDropdown',
            type: 'picklist',
            picklist: {
                type: 'picklistStatic',
                items: options
            }
        };

        // 发送更新请求
        await axios.patch(
            `https://dev.azure.com/${orgName}/${projectName}/_apis/wit/fields/${fieldRefName}?api-version=7.1-preview.3`,
            updateBody,
            { headers }
        );

        console.log('下拉选项更新成功');
    } catch (err) {
        console.error('操作失败:', err.response?.data || err.message);
    }
}

updateDropdown();

注意事项 #

• 先执行npm install axios安装依赖包。
• 同样要确保PAT权限足够，外部数据结构匹配脚本中的字段映射。

四、常见问题排查 #

• 权限错误：检查PAT的权限设置，必须勾选Work Item Tracking的Write权限。
• 外部API请求失败：用Postman测试目标API，确认能正常返回JSON，且脚本中的请求方法、头部配置正确。
• 字段更新失败：确认字段引用名正确（不是显示名），API版本兼容，请求体结构符合Azure DevOps要求（比如picklist.type必须是picklistStatic）。
• 增量更新需求：如果需要保留原有选项并新增，可先调用GET接口https://dev.azure.com/{org}/{project}/_apis/wit/fields/{fieldRefName}?api-version=7.1-preview.3获取现有选项，合并后再提交更新。

内容的提问来源于stack exchange，提问作者sanand