Class WorkApi

constructor

• new WorkApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): WorkApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns WorkApi

Static ReadonlyRESOURCE_AREA_ID

createPlan

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

  Add a new plan for the team

  Parameters

  • postedPlan: CreatePlan

    Plan definition
  • project: string

    Project ID or project name

  Returns Promise<Plan>

deletePlan

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

  Delete the specified plan

  Parameters

  • project: string

    Project ID or project name
  • id: string

    Identifier of the plan

  Returns Promise<void>

deleteTeamIteration

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

  Delete a team's iteration by iterationId

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • id: string

    ID of the iteration

  Returns Promise<void>

getBacklog

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

  Get a backlog level

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • id: string

    The id of the backlog level

  Returns Promise<BacklogLevelConfiguration>

getBacklogConfigurations

• getBacklogConfigurations(
      teamContext: TeamContext,
  ): Promise<BacklogConfiguration>

  Gets backlog configuration for a team

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<BacklogConfiguration>

getBacklogLevelWorkItems

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

  Get a list of work items within a backlog level

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • backlogId: string

  Returns Promise<BacklogLevelWorkItems>

getBacklogs

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

  List all backlog levels

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<BacklogLevelConfiguration[]>

getBoard

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

  Get board

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • id: string

    identifier for board, either board's backlog level name (Eg:"Stories") or Id

  Returns Promise<Board>

getBoardBadge

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

  Gets a badge that displays the status of columns on the board.

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • id: string

    The id of the board.
  • OptionalcolumnOptions: BoardBadgeColumnOptions

    Determines what columns to show.
  • Optionalcolumns: string[]

    If columnOptions is set to custom, specify the list of column names.

  Returns Promise<BoardBadge>

getBoardBadgeData

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

  Gets a badge that displays the status of columns on the board.

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • id: string

    The id of the board.
  • OptionalcolumnOptions: BoardBadgeColumnOptions

    Determines what columns to show.
  • Optionalcolumns: string[]

    If columnOptions is set to custom, specify the list of column names.

  Returns Promise<string>

getBoardCardRuleSettings

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

  Get board card Rule settings for the board id or board by name

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

  Returns Promise<BoardCardRuleSettings>

getBoardCardSettings

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

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

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

  Returns Promise<BoardCardSettings>

getBoardChart

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

  Get a board chart

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Identifier for board, either board's backlog level name (Eg:"Stories") or Id
  • name: string

    The chart name

  Returns Promise<BoardChart>

getBoardCharts

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

  Get board charts

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Identifier for board, either board's backlog level name (Eg:"Stories") or Id

  Returns Promise<BoardChartReference[]>

getBoardColumns

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

  Get columns on a board

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Name or ID of the specific board

  Returns Promise<BoardColumn[]>

getBoardMappingParentItems

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

  Returns the list of parent field filter model for the given list of workitem ids

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • childBacklogContextCategoryRefName: string
  • workitemIds: number[]

  Returns Promise<ParentChildWIMap[]>

getBoardRows

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

  Get rows on a board

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Name or ID of the specific board

  Returns Promise<BoardRow[]>

getBoards

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

  Get boards

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<BoardReference[]>

getBoardUserSettings

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

  Get board user settings for a board id

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Board ID or Name

  Returns Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals

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

  Get a team's capacity including total capacity and days off

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration

  Returns Promise<TeamCapacity>

getCapacityWithIdentityRef

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

  Get a team member's capacity

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration
  • teamMemberId: string

    ID of the team member

  Returns Promise<TeamMemberCapacityIdentityRef>

getColumns

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

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TaskboardColumns>

getColumnSuggestedValues

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

  Get available board columns in a project

  Parameters

  • Optionalproject: string

    Project ID or project name

  Returns Promise<BoardSuggestedValue[]>

getDeliveryTimelineData

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

  Get Delivery View Data

  Parameters

  • project: string

    Project ID or project name
  • id: string

    Identifier for delivery view
  • Optionalrevision: number

    Revision of the plan for which you want data. If the current plan is a different revision you will get an ViewRevisionMismatchException exception. If you do not supply a revision you will get data for the latest revision.
  • OptionalstartDate: Date

    The start date of timeline
  • OptionalendDate: Date

    The end date of timeline

  Returns Promise<DeliveryViewData>

getIterationWorkItems

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

  Get work items for iteration

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration

  Returns Promise<IterationWorkItems>

getPlan

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

  Get the information for the specified plan

  Parameters

  • project: string

    Project ID or project name
  • id: string

    Identifier of the plan

  Returns Promise<Plan>

getPlans

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

  Get the information for all the plans configured for the given team

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<Plan[]>

getProcessConfiguration

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

  Get process configuration

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ProcessConfiguration>

getRowSuggestedValues

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

  Get available board rows in a project

  Parameters

  • Optionalproject: string

    Project ID or project name

  Returns Promise<BoardSuggestedValue[]>

getTeamDaysOff

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

  Get team's days off for an iteration

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration

  Returns Promise<TeamSettingsDaysOff>

getTeamFieldValues

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

  Get a collection of team field values

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TeamFieldValues>

getTeamIteration

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

  Get team's iteration by iterationId

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • id: string

    ID of the iteration

  Returns Promise<TeamSettingsIteration>

getTeamIterations

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

  Get a team's iterations using timeframe filter

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • Optionaltimeframe: string

    A filter for which iterations are returned based on relative time. Only Current is supported currently.

  Returns Promise<TeamSettingsIteration[]>

getTeamSettings

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

  Get a team's settings

  Parameters

  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TeamSetting>

getTotalIterationCapacities

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

  Get an iteration's capacity for all teams in iteration

  Parameters

  • project: string

    Project ID or project name
  • iterationId: string

    ID of the iteration

  Returns Promise<IterationCapacity>

getWorkItemColumns

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

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

  Returns Promise<TaskboardWorkItemColumn[]>

postTeamIteration

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

  Add an iteration to the team

  Parameters

  • iteration: TeamSettingsIteration

    Iteration to add
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TeamSettingsIteration>

reorderBacklogWorkItems

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

  Reorder Product Backlog/Boards Work Items

  Parameters

  • operation: ReorderOperation
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<ReorderResult[]>

reorderIterationWorkItems

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

  Reorder Sprint Backlog/Taskboard Work Items

  Parameters

  • operation: ReorderOperation
  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    The id of the iteration

  Returns Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef

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

  Replace a team's capacity

  Parameters

  • capacities: TeamMemberCapacityIdentityRef[]

    Team capacity to replace
  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration

  Returns Promise<TeamMemberCapacityIdentityRef[]>

setBoardOptions

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

  Update board options

  Parameters

  • options: { [key: string]: string }

    options to updated
  • teamContext: TeamContext

    The team context for the operation
  • id: string

    identifier for board, either category plural name (Eg:"Stories") or guid

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

updateAutomationRule

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

  Creates/updates an automation rules settings

  Parameters

  • ruleRequestModel: TeamAutomationRulesSettingsRequestModel

    Required parameters to create/update an automation rules settings
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<void>

updateBoardCardRuleSettings

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

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

  Parameters

  • boardCardRuleSettings: BoardCardRuleSettings
  • teamContext: TeamContext

    The team context for the operation
  • board: string

  Returns Promise<BoardCardRuleSettings>

updateBoardCardSettings

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

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

  Parameters

  • boardCardSettingsToSave: BoardCardSettings
  • teamContext: TeamContext

    The team context for the operation
  • board: string

  Returns Promise<BoardCardSettings>

updateBoardChart

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

  Update a board chart

  Parameters

  • chart: BoardChart
  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Identifier for board, either board's backlog level name (Eg:"Stories") or Id
  • name: string

    The chart name

  Returns Promise<BoardChart>

updateBoardColumns

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

  Update columns on a board

  Parameters

  • boardColumns: BoardColumn[]

    List of board columns to update
  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Name or ID of the specific board

  Returns Promise<BoardColumn[]>

updateBoardRows

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

  Update rows on a board

  Parameters

  • boardRows: BoardRow[]

    List of board rows to update
  • teamContext: TeamContext

    The team context for the operation
  • board: string

    Name or ID of the specific board

  Returns Promise<BoardRow[]>

updateBoardUserSettings

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

  Update board user settings for the board id

  Parameters

  • boardUserSettings: { [key: string]: string }
  • teamContext: TeamContext

    The team context for the operation
  • board: string

  Returns Promise<BoardUserSettings>

updateCapacityWithIdentityRef

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

  Update a team member's capacity

  Parameters

  • patch: CapacityPatch

    Updated capacity
  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration
  • teamMemberId: string

    ID of the team member

  Returns Promise<TeamMemberCapacityIdentityRef>

updateColumns

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

  Parameters

  • updateColumns: UpdateTaskboardColumn[]
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TaskboardColumns>

updatePlan

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

  Update the information for the specified plan

  Parameters

  • updatedPlan: UpdatePlan

    Plan definition to be updated
  • project: string

    Project ID or project name
  • id: string

    Identifier of the plan

  Returns Promise<Plan>

updateTaskboardCardRuleSettings

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

  Update taskboard card Rule settings

  Parameters

  • boardCardRuleSettings: BoardCardRuleSettings
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<void>

updateTaskboardCardSettings

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

  Update taskboard card settings

  Parameters

  • boardCardSettingsToSave: BoardCardSettings
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<void>

updateTeamDaysOff

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

  Set a team's days off for an iteration

  Parameters

  • daysOffPatch: TeamSettingsDaysOffPatch

    Team's days off patch containing a list of start and end dates
  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string

    ID of the iteration

  Returns Promise<TeamSettingsDaysOff>

updateTeamFieldValues

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

  Update team field values

  Parameters

  • patch: TeamFieldValuesPatch
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TeamFieldValues>

updateTeamSettings

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

  Update a team's settings

  Parameters

  • teamSettingsPatch: TeamSettingsPatch

    TeamSettings changes
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TeamSetting>

updateWorkItemColumn

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

  Parameters

  • updateColumn: UpdateTaskboardWorkItemColumn
  • teamContext: TeamContext

    The team context for the operation
  • iterationId: string
  • workItemId: number

  Returns Promise<void>