WorkRestClient class

应使用的基类 (派生自) 以向 VSS REST API 发出请求

Extends

构造函数

WorkRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

createPlan(CreatePlan, string)

为团队添加新计划

deletePlan(string, string)

删除指定的计划

deleteTeamIteration(TeamContext, string)

通过 iterationId 删除团队的迭代

getBacklog(TeamContext, string)

获取积压工作级别

getBacklogConfigurations(TeamContext)

获取团队的积压工作配置

getBacklogLevelWorkItems(TeamContext, string)

获取积压工作级别内的工作项列表

getBacklogs(TeamContext)

列出所有积压工作级别

getBoard(TeamContext, string)

获取板

getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])

获取显示板上列状态的锁屏提醒。

getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])

获取显示板上列状态的锁屏提醒。

getBoardCardRuleSettings(TeamContext, string)

按名称获取板卡板 ID 或板的规则设置

getBoardCardSettings(TeamContext, string)

按名称获取板 ID 或板的板卡设置

getBoardChart(TeamContext, string, string)

获取板图

getBoardCharts(TeamContext, string)

获取板图表

getBoardColumns(TeamContext, string)

获取板上的列

getBoardMappingParentItems(TeamContext, string, number[])

返回给定的工作项 ID 列表的父字段筛选器模型列表

getBoardRows(TeamContext, string)

获取板上的行

getBoards(TeamContext)

获取板

getBoardUserSettings(TeamContext, string)

获取板 ID 的板用户设置

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

获取团队的容量,包括总容量和休假天数

getCapacityWithIdentityRef(TeamContext, string, string)

获取团队成员的容量

getColumns(TeamContext)
getColumnSuggestedValues(string)

获取项目中的可用板列

getDeliveryTimelineData(string, string, number, Date, Date)

获取传递视图数据

getIterationWorkItems(TeamContext, string)

获取用于迭代的工作项

getPlan(string, string)

获取指定计划的信息

getPlans(string)

获取为给定团队配置的所有计划的信息

getProcessConfiguration(string)

获取进程配置

getRowSuggestedValues(string)

获取项目中的可用板行

getTeamDaysOff(TeamContext, string)

让团队休息一天进行迭代

getTeamFieldValues(TeamContext)

获取团队字段值的集合

getTeamIteration(TeamContext, string)

通过 iterationId 获取团队的迭代

getTeamIterations(TeamContext, string)

使用时间范围筛选器获取团队的迭代

getTeamSettings(TeamContext)

获取团队的设置

getTotalIterationCapacities(string, string)

获取迭代中所有团队的迭代容量

getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)

向团队添加迭代

reorderBacklogWorkItems(ReorderOperation, TeamContext)

重新排序产品积压工作/板工作项

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

重新排序冲刺积压工作/任务板工作项

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

替换团队的容量

setBoardOptions({[key: string]: string}, TeamContext, string)

更新板选项

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

创建/更新自动化规则设置

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

按名称更新板卡板 ID 或板的规则设置

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

按名称更新板卡板 ID 或板的设置

updateBoardChart(BoardChart, TeamContext, string, string)

更新板图

updateBoardColumns(BoardColumn[], TeamContext, string)

更新板上的列

updateBoardRows(BoardRow[], TeamContext, string)

更新板上的行

updateBoardUserSettings({[key: string]: string}, TeamContext, string)

更新板 ID 的板用户设置

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

更新团队成员的容量

updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)

更新指定计划的信息

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

更新任务板卡规则设置

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

更新任务板卡设置

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

为迭代设置团队休息日

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

更新团队字段值

updateTeamSettings(TeamSettingsPatch, TeamContext)

更新团队的设置

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

构造函数详细信息

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

参数

属性详细信息

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

属性值

string

方法详细信息

createPlan(CreatePlan, string)

为团队添加新计划

function createPlan(postedPlan: CreatePlan, project: string): Promise<Plan>

参数

postedPlan
CreatePlan

计划定义

project

string

项目 ID 或项目名称

返回

Promise<Plan>

deletePlan(string, string)

删除指定的计划

function deletePlan(project: string, id: string): Promise<void>

参数

project

string

项目 ID 或项目名称

id

string

计划的标识符

返回

Promise<void>

deleteTeamIteration(TeamContext, string)

通过 iterationId 删除团队的迭代

function deleteTeamIteration(teamContext: TeamContext, id: string): Promise<void>

参数

teamContext
TeamContext

操作的团队上下文

id

string

迭代的 ID

返回

Promise<void>

getBacklog(TeamContext, string)

获取积压工作级别

function getBacklog(teamContext: TeamContext, id: string): Promise<BacklogLevelConfiguration>

参数

teamContext
TeamContext

操作的团队上下文

id

string

积压工作级别的 ID

返回

getBacklogConfigurations(TeamContext)

获取团队的积压工作配置

function getBacklogConfigurations(teamContext: TeamContext): Promise<BacklogConfiguration>

参数

teamContext
TeamContext

操作的团队上下文

返回

getBacklogLevelWorkItems(TeamContext, string)

获取积压工作级别内的工作项列表

function getBacklogLevelWorkItems(teamContext: TeamContext, backlogId: string): Promise<BacklogLevelWorkItems>

参数

teamContext
TeamContext

操作的团队上下文

backlogId

string

返回

getBacklogs(TeamContext)

列出所有积压工作级别

function getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>

参数

teamContext
TeamContext

操作的团队上下文

返回

getBoard(TeamContext, string)

获取板

function getBoard(teamContext: TeamContext, id: string): Promise<Board>

参数

teamContext
TeamContext

操作的团队上下文

id

string

板的标识符,板的积压工作级别名称 (例如:“Stories”) 或 ID

返回

Promise<Board>

getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])

获取显示板上列状态的锁屏提醒。

function getBoardBadge(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<BoardBadge>

参数

teamContext
TeamContext

操作的团队上下文

id

string

板的 ID。

columnOptions
BoardBadgeColumnOptions

确定要显示的列。

columns

string[]

如果 columnOptions 设置为 custom,请指定列名列表。

返回

Promise<BoardBadge>

getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])

获取显示板上列状态的锁屏提醒。

function getBoardBadgeData(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<string>

参数

teamContext
TeamContext

操作的团队上下文

id

string

板的 ID。

columnOptions
BoardBadgeColumnOptions

确定要显示的列。

columns

string[]

如果 columnOptions 设置为 custom,请指定列名列表。

返回

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

按名称获取板卡板 ID 或板的规则设置

function getBoardCardRuleSettings(teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>

参数

teamContext
TeamContext

操作的团队上下文

board

string

返回

getBoardCardSettings(TeamContext, string)

按名称获取板 ID 或板的板卡设置

function getBoardCardSettings(teamContext: TeamContext, board: string): Promise<BoardCardSettings>

参数

teamContext
TeamContext

操作的团队上下文

board

string

返回

getBoardChart(TeamContext, string, string)

获取板图

function getBoardChart(teamContext: TeamContext, board: string, name: string): Promise<BoardChart>

参数

teamContext
TeamContext

操作的团队上下文

board

string

板的标识符,板的积压工作级别名称 (例如:“Stories”) 或 Id

name

string

图表名称

返回

Promise<BoardChart>

getBoardCharts(TeamContext, string)

获取板图表

function getBoardCharts(teamContext: TeamContext, board: string): Promise<BoardChartReference[]>

参数

teamContext
TeamContext

操作的团队上下文

board

string

板的标识符,板的积压工作级别名称 (例如:“Stories”) 或 Id

返回

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

获取板上的列

function getBoardColumns(teamContext: TeamContext, board: string): Promise<BoardColumn[]>

参数

teamContext
TeamContext

操作的团队上下文

board

string

特定板的名称或 ID

返回

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

返回给定的工作项 ID 列表的父字段筛选器模型列表

function getBoardMappingParentItems(teamContext: TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<ParentChildWIMap[]>

参数

teamContext
TeamContext

操作的团队上下文

childBacklogContextCategoryRefName

string

workitemIds

number[]

返回

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

获取板上的行

function getBoardRows(teamContext: TeamContext, board: string): Promise<BoardRow[]>

参数

teamContext
TeamContext

操作的团队上下文

board

string

特定板的名称或 ID

返回

Promise<BoardRow[]>

getBoards(TeamContext)

获取板

function getBoards(teamContext: TeamContext): Promise<BoardReference[]>

参数

teamContext
TeamContext

操作的团队上下文

返回

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

获取板 ID 的板用户设置

function getBoardUserSettings(teamContext: TeamContext, board: string): Promise<BoardUserSettings>

参数

teamContext
TeamContext

操作的团队上下文

board

string

板 ID 或名称

返回

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

获取团队的容量,包括总容量和休假天数

function getCapacitiesWithIdentityRefAndTotals(teamContext: TeamContext, iterationId: string): Promise<TeamCapacity>

参数

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

返回

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

获取团队成员的容量

function getCapacityWithIdentityRef(teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>

参数

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

teamMemberId

string

团队成员的 ID

返回

getColumns(TeamContext)

function getColumns(teamContext: TeamContext): Promise<TaskboardColumns>

参数

teamContext
TeamContext

操作的团队上下文

返回

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

获取项目中的可用板列

function getColumnSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>

参数

project

string

项目 ID 或项目名称

返回

Promise<BoardSuggestedValue[]>

getDeliveryTimelineData(string, string, number, Date, Date)

获取传递视图数据

function getDeliveryTimelineData(project: string, id: string, revision?: number, startDate?: Date, endDate?: Date): Promise<DeliveryViewData>

参数

project

string

项目 ID 或项目名称

id

string

传递视图的标识符

revision

number

需要数据的计划的修订。 如果当前计划是不同的修订,则会收到 ViewRevisionMismatchException 异常。 如果不提供修订,你将获得最新版本的数据。

startDate

Date

时间线的开始日期

endDate

Date

时间线结束日期

返回

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

获取用于迭代的工作项

function getIterationWorkItems(teamContext: TeamContext, iterationId: string): Promise<IterationWorkItems>

参数

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

返回

getPlan(string, string)

获取指定计划的信息

function getPlan(project: string, id: string): Promise<Plan>

参数

project

string

项目 ID 或项目名称

id

string

计划的标识符

返回

Promise<Plan>

getPlans(string)

获取为给定团队配置的所有计划的信息

function getPlans(project: string): Promise<Plan[]>

参数

project

string

项目 ID 或项目名称

返回

Promise<Plan[]>

getProcessConfiguration(string)

获取进程配置

function getProcessConfiguration(project: string): Promise<ProcessConfiguration>

参数

project

string

项目 ID 或项目名称

返回

getRowSuggestedValues(string)

获取项目中的可用板行

function getRowSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>

参数

project

string

项目 ID 或项目名称

返回

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

让团队休息一天进行迭代

function getTeamDaysOff(teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>

参数

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

返回

getTeamFieldValues(TeamContext)

获取团队字段值的集合

function getTeamFieldValues(teamContext: TeamContext): Promise<TeamFieldValues>

参数

teamContext
TeamContext

操作的团队上下文

返回

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

通过 iterationId 获取团队的迭代

function getTeamIteration(teamContext: TeamContext, id: string): Promise<TeamSettingsIteration>

参数

teamContext
TeamContext

操作的团队上下文

id

string

迭代的 ID

返回

getTeamIterations(TeamContext, string)

使用时间范围筛选器获取团队的迭代

function getTeamIterations(teamContext: TeamContext, timeframe?: string): Promise<TeamSettingsIteration[]>

参数

teamContext
TeamContext

操作的团队上下文

timeframe

string

基于相对时间返回迭代的筛选器。 目前仅支持 Current。

返回

getTeamSettings(TeamContext)

获取团队的设置

function getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>

参数

teamContext
TeamContext

操作的团队上下文

返回

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

获取迭代中所有团队的迭代容量

function getTotalIterationCapacities(project: string, iterationId: string): Promise<IterationCapacity>

参数

project

string

项目 ID 或项目名称

iterationId

string

迭代的 ID

返回

getWorkItemColumns(TeamContext, string)

function getWorkItemColumns(teamContext: TeamContext, iterationId: string): Promise<TaskboardWorkItemColumn[]>

参数

teamContext
TeamContext

操作的团队上下文

iterationId

string

返回

postTeamIteration(TeamSettingsIteration, TeamContext)

向团队添加迭代

function postTeamIteration(iteration: TeamSettingsIteration, teamContext: TeamContext): Promise<TeamSettingsIteration>

参数

iteration
TeamSettingsIteration

要添加的迭代

teamContext
TeamContext

操作的团队上下文

返回

reorderBacklogWorkItems(ReorderOperation, TeamContext)

重新排序产品积压工作/板工作项

function reorderBacklogWorkItems(operation: ReorderOperation, teamContext: TeamContext): Promise<ReorderResult[]>

参数

operation
ReorderOperation
teamContext
TeamContext

操作的团队上下文

返回

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

重新排序冲刺积压工作/任务板工作项

function reorderIterationWorkItems(operation: ReorderOperation, teamContext: TeamContext, iterationId: string): Promise<ReorderResult[]>

参数

operation
ReorderOperation
teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

返回

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

替换团队的容量

function replaceCapacitiesWithIdentityRef(capacities: TeamMemberCapacityIdentityRef[], teamContext: TeamContext, iterationId: string): Promise<TeamMemberCapacityIdentityRef[]>

参数

capacities

TeamMemberCapacityIdentityRef[]

要替换的团队容量

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

返回

setBoardOptions({[key: string]: string}, TeamContext, string)

更新板选项

function setBoardOptions(options: {[key: string]: string}, teamContext: TeamContext, id: string): Promise<{[key: string]: string}>

参数

options

{[key: string]: string}

要更新的选项

teamContext
TeamContext

操作的团队上下文

id

string

板的标识符,类别复数名称 (例如:“Stories”) 或 guid

返回

Promise<{[key: string]: string}>

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

创建/更新自动化规则设置

function updateAutomationRule(ruleRequestModel: TeamAutomationRulesSettingsRequestModel, teamContext: TeamContext): Promise<void>

参数

ruleRequestModel
TeamAutomationRulesSettingsRequestModel

创建/更新自动化规则设置所需的参数

teamContext
TeamContext

操作的团队上下文

返回

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

按名称更新板卡板 ID 或板的规则设置

function updateBoardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>

参数

boardCardRuleSettings
BoardCardRuleSettings
teamContext
TeamContext

操作的团队上下文

board

string

返回

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

按名称更新板卡板 ID 或板的设置

function updateBoardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext, board: string): Promise<BoardCardSettings>

参数

boardCardSettingsToSave
BoardCardSettings
teamContext
TeamContext

操作的团队上下文

board

string

返回

updateBoardChart(BoardChart, TeamContext, string, string)

更新板图

function updateBoardChart(chart: BoardChart, teamContext: TeamContext, board: string, name: string): Promise<BoardChart>

参数

chart
BoardChart
teamContext
TeamContext

操作的团队上下文

board

string

板的标识符,板的积压工作级别名称 (例如:“Stories”) 或 Id

name

string

图表名称

返回

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

更新板上的列

function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>

参数

boardColumns

BoardColumn[]

要更新的板列列表

teamContext
TeamContext

操作的团队上下文

board

string

特定板的名称或 ID

返回

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

更新板上的行

function updateBoardRows(boardRows: BoardRow[], teamContext: TeamContext, board: string): Promise<BoardRow[]>

参数

boardRows

BoardRow[]

要更新的板行列表

teamContext
TeamContext

操作的团队上下文

board

string

特定板的名称或 ID

返回

Promise<BoardRow[]>

updateBoardUserSettings({[key: string]: string}, TeamContext, string)

更新板 ID 的板用户设置

function updateBoardUserSettings(boardUserSettings: {[key: string]: string}, teamContext: TeamContext, board: string): Promise<BoardUserSettings>

参数

boardUserSettings

{[key: string]: string}

teamContext
TeamContext

操作的团队上下文

board

string

返回

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

更新团队成员的容量

function updateCapacityWithIdentityRef(patch: CapacityPatch, teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>

参数

patch
CapacityPatch

更新的容量

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

teamMemberId

string

团队成员的 ID

返回

updateColumns(UpdateTaskboardColumn[], TeamContext)

function updateColumns(updateColumns: UpdateTaskboardColumn[], teamContext: TeamContext): Promise<TaskboardColumns>

参数

updateColumns

UpdateTaskboardColumn[]

teamContext
TeamContext

操作的团队上下文

返回

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

更新指定计划的信息

function updatePlan(updatedPlan: UpdatePlan, project: string, id: string): Promise<Plan>

参数

updatedPlan
UpdatePlan

要更新的计划定义

project

string

项目 ID 或项目名称

id

string

计划的标识符

返回

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

更新任务板卡规则设置

function updateTaskboardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext): Promise<void>

参数

boardCardRuleSettings
BoardCardRuleSettings
teamContext
TeamContext

操作的团队上下文

返回

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

更新任务板卡设置

function updateTaskboardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext): Promise<void>

参数

boardCardSettingsToSave
BoardCardSettings
teamContext
TeamContext

操作的团队上下文

返回

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

为迭代设置团队休息日

function updateTeamDaysOff(daysOffPatch: TeamSettingsDaysOffPatch, teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>

参数

daysOffPatch
TeamSettingsDaysOffPatch

包含开始和结束日期列表的团队休息日补丁

teamContext
TeamContext

操作的团队上下文

iterationId

string

迭代的 ID

返回

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

更新团队字段值

function updateTeamFieldValues(patch: TeamFieldValuesPatch, teamContext: TeamContext): Promise<TeamFieldValues>

参数

teamContext
TeamContext

操作的团队上下文

返回

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

更新团队的设置

function updateTeamSettings(teamSettingsPatch: TeamSettingsPatch, teamContext: TeamContext): Promise<TeamSetting>

参数

teamSettingsPatch
TeamSettingsPatch

TeamSettings 更改

teamContext
TeamContext

操作的团队上下文

返回

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

function updateWorkItemColumn(updateColumn: UpdateTaskboardWorkItemColumn, teamContext: TeamContext, iterationId: string, workItemId: number): Promise<void>

参数

teamContext
TeamContext

操作的团队上下文

iterationId

string

workItemId

number

返回

Promise<void>