WorkHttpClient2_2
Important
Disclaimer: This API is in private preview and subject to change. This API is in private preview and subject to change.
Module path: TFS/Work/RestClient
Initialization sample
import RestClient = require("TFS/Work/RestClient");
// Get an instance of the client
var client = RestClient.getClient();
// Call a method on the client
// e.g. client.getResource(...).then(...);
Methods
- deleteTeamIteration()
- getBoard()
- getBoardCardRuleSettings()
- getBoardCardSettings()
- getBoardChart()
- getBoardCharts()
- getBoardColumns()
- getBoardRows()
- getBoards()
- getCapacities()
- getCapacity()
- getColumnSuggestedValues()
- getRowSuggestedValues()
- getTeamDaysOff()
- getTeamFieldValues()
- getTeamIteration()
- getTeamIterations()
- getTeamSettings()
- postTeamIteration()
- replaceCapacities()
- setBoardOptions()
- updateBoardCardRuleSettings()
- updateBoardCardSettings()
- updateBoardChart()
- updateBoardColumns()
- updateBoardRows()
- updateCapacity()
- updateTeamDaysOff()
- updateTeamFieldValues()
- updateTeamSettings()
deleteTeamIteration()
Syntax
IPromise<void> deleteTeamIteration(teamContext, id)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationid
: string.
Returns
- IPromise<void>
getBoard()
Get board
Syntax
IPromise<Contracts.Board> getBoard(teamContext, id)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationid
: string. identifier for board, either category plural name (Eg:"Stories") or guid
Returns
getBoardCardRuleSettings()
Get board card Rule settings for the board ID or board by name
Syntax
IPromise<Contracts.BoardCardRuleSettings> getBoardCardRuleSettings(teamContext, board)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationboard
: string.
Returns
getBoardCardSettings()
Get board card settings for the board ID or board by name
Syntax
IPromise<Contracts.BoardCardSettings> getBoardCardSettings(teamContext, board)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationboard
: string.
Returns
getBoardChart()
Get a board chart
Syntax
IPromise<Contracts.BoardChart> getBoardChart(teamContext, board, name)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationboard
: string. Identifier for board, either category plural name (Eg:"Stories") or Guidname
: string. The chart name
Returns
getBoardCharts()
Get board charts
Syntax
IPromise<Contracts.BoardChartReference[]> getBoardCharts(teamContext, board)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationboard
: string. Identifier for board, either category plural name (Eg:"Stories") or Guid
Returns
getBoardColumns()
Syntax
IPromise<Contracts.BoardColumn[]> getBoardColumns(teamContext, board)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationboard
: string.
Returns
getBoardRows()
Syntax
IPromise<Contracts.BoardRow[]> getBoardRows(teamContext, board)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationboard
: string.
Returns
getBoards()
Syntax
IPromise<Contracts.BoardReference[]> getBoards(teamContext)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operation
Returns
getCapacities()
Syntax
IPromise<Contracts.TeamMemberCapacity[]> getCapacities(teamContext, iterationId)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationiterationId
: string.
Returns
getCapacity()
Syntax
IPromise<Contracts.TeamMemberCapacity> getCapacity(teamContext, iterationId, teamMemberId)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationiterationId
: string.teamMemberId
: string.
Returns
getColumnSuggestedValues()
Syntax
IPromise<Contracts.BoardSuggestedValue[]> getColumnSuggestedValues(project)
Parameters
project
: string. Optional. Project ID or project name
Returns
getRowSuggestedValues()
Syntax
IPromise<Contracts.BoardSuggestedValue[]> getRowSuggestedValues(project)
Parameters
project
: string. Optional. Project ID or project name
Returns
getTeamDaysOff()
Syntax
IPromise<Contracts.TeamSettingsDaysOff> getTeamDaysOff(teamContext, iterationId)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationiterationId
: string.
Returns
getTeamFieldValues()
Syntax
IPromise<Contracts.TeamFieldValues> getTeamFieldValues(teamContext)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operation
Returns
getTeamIteration()
Syntax
IPromise<Contracts.TeamSettingsIteration> getTeamIteration(teamContext, id)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationid
: string.
Returns
getTeamIterations()
Syntax
IPromise<Contracts.TeamSettingsIteration[]> getTeamIterations(teamContext, timeframe)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operationtimeframe
: string. Optional.
Returns
getTeamSettings()
Syntax
IPromise<Contracts.TeamSetting> getTeamSettings(teamContext)
Parameters
teamContext
: TFS_Core_Contracts.TeamContext. The team context for the operation
Returns
postTeamIteration()
Syntax
IPromise<Contracts.TeamSettingsIteration> postTeamIteration(iteration, teamContext)
Parameters
iteration
: Contracts.TeamSettingsIteration.teamContext
: TFS_Core_Contracts.TeamContext.
Returns
replaceCapacities()
Syntax
IPromise<Contracts.TeamMemberCapacity[]> replaceCapacities(capacities, teamContext, iterationId)
Parameters
capacities
: Contracts.TeamMemberCapacity[].teamContext
: TFS_Core_Contracts.TeamContext.iterationId
: string.
Returns
setBoardOptions()
Update board options
Syntax
IPromise<{[key: string]: string}> setBoardOptions(options, teamContext, id)
Parameters
options
: {[key: string]: string}. options to updatedteamContext
: TFS_Core_Contracts.TeamContext.id
: string.
Returns
- IPromise<{[key: string]: string}>
updateBoardCardRuleSettings()
Update board card Rule settings for the board ID or board by name
Syntax
IPromise<Contracts.BoardCardRuleSettings> updateBoardCardRuleSettings(boardCardRuleSettings, teamContext, board)
Parameters
boardCardRuleSettings
: Contracts.BoardCardRuleSettings.teamContext
: TFS_Core_Contracts.TeamContext.board
: string.
Returns
updateBoardCardSettings()
Update board card settings for the board ID or board by name
Syntax
IPromise<Contracts.BoardCardSettings> updateBoardCardSettings(boardCardSettingsToSave, teamContext, board)
Parameters
boardCardSettingsToSave
: Contracts.BoardCardSettings.teamContext
: TFS_Core_Contracts.TeamContext.board
: string.
Returns
updateBoardChart()
Update a board chart
Syntax
IPromise<Contracts.BoardChart> updateBoardChart(chart, teamContext, board, name)
Parameters
chart
: Contracts.BoardChart.teamContext
: TFS_Core_Contracts.TeamContext.board
: string.name
: string.
Returns
updateBoardColumns()
Syntax
IPromise<Contracts.BoardColumn[]> updateBoardColumns(boardColumns, teamContext, board)
Parameters
boardColumns
: Contracts.BoardColumn[].teamContext
: TFS_Core_Contracts.TeamContext.board
: string.
Returns
updateBoardRows()
Syntax
IPromise<Contracts.BoardRow[]> updateBoardRows(boardRows, teamContext, board)
Parameters
boardRows
: Contracts.BoardRow[].teamContext
: TFS_Core_Contracts.TeamContext.board
: string.
Returns
updateCapacity()
Syntax
IPromise<Contracts.TeamMemberCapacity> updateCapacity(patch, teamContext, iterationId, teamMemberId)
Parameters
patch
: Contracts.CapacityPatch.teamContext
: TFS_Core_Contracts.TeamContext.iterationId
: string.teamMemberId
: string.
Returns
updateTeamDaysOff()
Syntax
IPromise<Contracts.TeamSettingsDaysOff> updateTeamDaysOff(daysOffPatch, teamContext, iterationId)
Parameters
daysOffPatch
: Contracts.TeamSettingsDaysOffPatch.teamContext
: TFS_Core_Contracts.TeamContext.iterationId
: string.
Returns
updateTeamFieldValues()
Syntax
IPromise<Contracts.TeamFieldValues> updateTeamFieldValues(patch, teamContext)
Parameters
patch
: Contracts.TeamFieldValuesPatch.teamContext
: TFS_Core_Contracts.TeamContext.
Returns
updateTeamSettings()
Syntax
IPromise<Contracts.TeamSetting> updateTeamSettings(teamSettingsPatch, teamContext)
Parameters
teamSettingsPatch
: Contracts.TeamSettingsPatch.teamContext
: TFS_Core_Contracts.TeamContext.