Work
Common tasks with the board API
Add a column to a board
- Look up the boards for a team.
- Get column settings for a board.
- 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
- Look up the boards for a team.
- Get row settings for a board.
- Update row settings for a board.
Update card style rules on a board
- Get card styling rules for a board.
- Update card styling rules for a board.
Update chart settings
- List all the charts for a board.
- Get a specific chart by name a board.
- Update chart settings for a specific chart.
Team settings
Team 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
- Get a list of teams in a team project.
- Get the team settings of a team.
- Set the team settings of a team.
Get the list of areas or team field values that a team owns
- Get a list of teams in a team project.
- Get the areas or team field values of a team.
Change a team's ownership of areas or team field values
- Get a list of teams in a team project.
- Get a list of areas or team field values of a team.
- Set the areas or team field values of a team.
Add an iteration to the set of team iterations
- Get a list of teams in a team project.
- Get a list of iterations of a team.
- Set the iterations of a team.
Change a team member's capacity per day
- Get a list of teams in a team project.
- Get a list of iterations of a team.
- Get the capacity information for that iteration.
- 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
- Get a list of team projects in a collection
- Get the process configuration for a team project.
- Find the typeField mapping for "Effort".