Work

TFS 2017 | TFS 2015 | TFS 2013

Note

Looking for REST APIS that support TFS 2018 or later versions? See the Azure DevOps REST API Reference.

api-version = 2.0-preview.1

Work resources

• Boards
  • Columns
  • Rows
  • Card fields
  • Card rules
  • Chart
• Team settings
  • Team field values
  • Team iterations
  • Team capacity
  • Team days off
• Backlog Configuration
• Process Configuration (Deprecated)
• Plans
  • Delivery timeline

Common tasks with the board API

Add a column to a board

1. Look up the boards for a team.
2. Get column settings for a board.
3. Add a column to a board by including the new column's data to existing columns received in get column settings.

Update board row settings

1. Look up the boards for a team.
2. Get row settings for a board.
3. Update row settings for a board.

Update card fields on a board

1. Get card fields for a board.
2. Update card fields for a board.

Update card style rules on a board

1. Get card styling rules for a board.
2. Update card styling rules for a board.

Update chart settings

1. List all the charts for a board.
2. Get a specific chart by name a board.
3. Update chart settings for a specific chart.

Team settings

Projects have one or more teams that contribute to that project. This API enables editing of team settings (not project or process settings).

Setting Name	Description	Reference
backlogIteration	The base iteration used for portfolio backlogs.	Team Settings
bugsBehavior	Change the way bugs behave on the boards and in the backlogs (AsRequirements, AsTasks, Off).	Team Settings
workingDays	The days of the week that a team's members work.	Team Settings
backlogVisibilities	Which backlogs are visible in the team's backlog navigation.	Team Settings
teamFieldValues	The list of the team field values selected by a team. This defines what items are owned by a team.	Team Field Values
defaultValue	The default value for the team field.	Team Field Values
iterations	The list of iterations to which the team is subscribed.	Team Iterations
teamDaysOff	The a team's days off within an iteration.	Team Days Off
capacities	The list of team members' capacity information.	Team Capacity
activity	The type of work being done by a team member.	Team Capacity
capacityPerDay	The amount of work a team member can do in a day (per activity).	Team Capacity
daysOff	The days in a sprint that a team member is taking off.	Team Capacity

Common tasks with the Team Settings API

Change the bug behavior for the team

1. Get a list of teams in a project.
2. Get the team settings of a team.
3. Set the team settings of a team.

Get the list of areas or team field values that a team owns

1. Get a list of teams in a project.
2. Get the areas or team field values of a team.

Change a team's ownership of areas or team field values

1. Get a list of teams in a project.
2. Get a list of areas or team field values of a team.
3. Set the areas or team field values of a team.

Add an iteration to the set of team iterations

1. Get a list of teams in a project.
2. Get a list of iterations of a team.
3. Set the iterations of a team.

Change a team member's capacity per day

1. Get a list of teams in a project.
2. Get a list of iterations of a team.
3. Get the capacity information for that iteration.
4. Set the capacity of one team member for that iteration.

Common tasks with the Process Configuration API

Investigate what field maps to "Effort" in the agile experiences

1. Get a list of projects in a collection
2. Get the process configuration for a project.
3. Find the typeField mapping for "Effort".