Last Update: 9/26/2016

WorkHttpClient2_2

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()

Syntax

 IPromise<void> deleteTeamIteration(teamContext, id)

Parameters

Returns

getBoard()

Get board

Syntax

 IPromise<Contracts.Board> getBoard(teamContext, id)

Parameters

  • teamContext: TFS_Core_Contracts.TeamContext. The team context for the operation
  • id: 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

Returns

getBoardCardSettings()

Get board card settings for the board ID or board by name

Syntax

 IPromise<Contracts.BoardCardSettings> getBoardCardSettings(teamContext, board)

Parameters

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 operation
  • board: string. Identifier for board, either category plural name (Eg:"Stories") or Guid
  • name: 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 operation
  • board: string. Identifier for board, either category plural name (Eg:"Stories") or Guid

Returns

getBoardColumns()

Syntax

 IPromise<Contracts.BoardColumn[]> getBoardColumns(teamContext, board)

Parameters

Returns

getBoardRows()

Syntax

 IPromise<Contracts.BoardRow[]> getBoardRows(teamContext, board)

Parameters

Returns

getBoards()

Syntax

 IPromise<Contracts.BoardReference[]> getBoards(teamContext)

Parameters

Returns

getCapacities()

Syntax

 IPromise<Contracts.TeamMemberCapacity[]> getCapacities(teamContext, iterationId)

Parameters

Returns

getCapacity()

Syntax

 IPromise<Contracts.TeamMemberCapacity> getCapacity(teamContext, iterationId, teamMemberId)

Parameters

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

Returns

getTeamFieldValues()

Syntax

 IPromise<Contracts.TeamFieldValues> getTeamFieldValues(teamContext)

Parameters

Returns

getTeamIteration()

Syntax

 IPromise<Contracts.TeamSettingsIteration> getTeamIteration(teamContext, id)

Parameters

Returns

getTeamIterations()

Syntax

 IPromise<Contracts.TeamSettingsIteration[]> getTeamIterations(teamContext, timeframe)

Parameters

Returns

getTeamSettings()

Syntax

 IPromise<Contracts.TeamSetting> getTeamSettings(teamContext)

Parameters

Returns

postTeamIteration()

Syntax

 IPromise<Contracts.TeamSettingsIteration> postTeamIteration(iteration, teamContext)

Parameters

Returns

replaceCapacities()

Syntax

 IPromise<Contracts.TeamMemberCapacity[]> replaceCapacities(capacities, teamContext, iterationId)

Parameters

Returns

setBoardOptions()

Update board options

Syntax

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

Parameters

Returns

updateBoardCardRuleSettings()

Update board card Rule settings for the board ID or board by name

Syntax

 IPromise<Contracts.BoardCardRuleSettings> updateBoardCardRuleSettings(boardCardRuleSettings, teamContext, board)

Parameters

Returns

updateBoardCardSettings()

Update board card settings for the board ID or board by name

Syntax

 IPromise<Contracts.BoardCardSettings> updateBoardCardSettings(boardCardSettingsToSave, teamContext, board)

Parameters

Returns

updateBoardChart()

Update a board chart

Syntax

 IPromise<Contracts.BoardChart> updateBoardChart(chart, teamContext, board, name)

Parameters

Returns

updateBoardColumns()

Syntax

 IPromise<Contracts.BoardColumn[]> updateBoardColumns(boardColumns, teamContext, board)

Parameters

Returns

updateBoardRows()

Syntax

 IPromise<Contracts.BoardRow[]> updateBoardRows(boardRows, teamContext, board)

Parameters

Returns

updateCapacity()

Syntax

 IPromise<Contracts.TeamMemberCapacity> updateCapacity(patch, teamContext, iterationId, teamMemberId)

Parameters

Returns

updateTeamDaysOff()

Syntax

 IPromise<Contracts.TeamSettingsDaysOff> updateTeamDaysOff(daysOffPatch, teamContext, iterationId)

Parameters

Returns

updateTeamFieldValues()

Syntax

 IPromise<Contracts.TeamFieldValues> updateTeamFieldValues(patch, teamContext)

Parameters

Returns

updateTeamSettings()

Syntax

 IPromise<Contracts.TeamSetting> updateTeamSettings(teamSettingsPatch, teamContext)

Parameters

Returns