如何使用VSTS Node API设置积压迭代?

时间:2017-12-29 18:01:14

标签: javascript node.js azure-devops backlog

我正在尝试使用vso-node-api,我想自动为之前使用API​​创建的团队设置积压迭代。

我在使用updateTeamSettings中的WorkApi

时遇到了一些问题

updateTeamSettings(teamSettingsPatch: WorkInterfaces.TeamSettingsPatch, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSetting>;

如您所见,我需要提供teamSettingsPatch对象和teamContext对象。我已经找到teamContext并在其他调用中成功使用它,但我似乎无法提供导致API返回成功响应的teamSettingsPatch对象。到目前为止,我得到400 Bad Request和一个空对象作为回报({ }),我已尝试过。 (编辑:这个空对象和错误请求是由于我自己的包装器代码中的错误,使用不成功的TeamSettingsUpdate真正得到的是一个返回的设置对象,其值不是没有像你期望的那样改变。

WorkInterfaces.ts表示我需要提供这样的对象:

/**
 * Data contract for what we expect to receive when PATCH
 */
export interface TeamSettingsPatch {
    backlogIteration: string;
    backlogVisibilities: { [key: string] : boolean; };
    bugsBehavior: BugsBehavior;
    defaultIteration: string;
    defaultIterationMacro: string;
    workingDays: SystemInterfaces.DayOfWeek[];
}

我试图提供这样的对象。在我以前的经验中,vso-node-api希望定义所有属性,无论它们的值是否被任何东西填充,所以首先我尝试了这个:

{
    backlogIteration: 'Backlog-Iteration-Name',
    backlogVisibilities: { },
    bugsBehavior: null,
    defaultIteration: null,
    defaultIterationMacro: '@currentIteration',
    workingDays: [
        1,
        2,
        3,
        4,
        5
    ]
}

但是,当我尝试这个时,我仍然收到错误请求消息。

我还尝试使用getTeamSettings调用来尝试找出API对TeamSettingsPatch对象的要求,并且我已尝试填写所有可能的内容,包括已经存在的值从getTeamSettings向我展示。请注意,归零的GUID正是getTeamSettings给我的:

{
    backlogIteration: {
      id: '00000000-0000-0000-0000-000000000000'
    },
    backlogVisibilities: {
      'Custom.1f38c336-f308-41a6-adaa-eb78c0f72dd5': false,
      'Microsoft.FeatureCategory': true,
      'Microsoft.EpicCategory': false,
      'Microsoft.RequirementCategory': true
    },
    bugsBehavior: 2,
    defaultIteration: null,
    defaultIterationMacro: '@currentIteration',
    workingDays: [
      1,
      2,
      3,
      4,
      5
    ]
}

我有点失落。它不起作用,因为我在我的请求中提供了一个坏对象,或者它是否工作,因为这个API功能还没有工作呢?来自API的响应不提供任何提示,只提供空对象和400错误。

1 个答案:

答案 0 :(得分:1)

首先,它不适用于backlogIteration的名称,需要ID。

其次,backlogIteration的值不正确,我可以通过调用getTeamSettings函数获得正确的值(但你不能),你可以将vso-node-api更新到最新版本(例如6.2.8-preview)并检查结果,您也可以手动调用Get a team’s settings REST api来获取值。

我的teamSettingPatch:

{
        backlogIteration: "d3f3738d-d874-46a9-941d-54a5ca0f6f2d",
        backlogVisibilities:{
            "Microsoft.EpicCategory": false,
            "Microsoft.FeatureCategory": true,
         "Microsoft.RequirementCategory": true
        },
        bugsBehavior: 2,
        defaultIteration: null,
        defaultIterationMacro: null,
        workingDays:[
            1,
            2,
            3,
            4
          ]
    }