WorkRestClient class

new WorkRestClient(options: IVssRestClientOptions)

Parâmetros

static RESOURCE_AREA_ID: string

Valor de Propriedade

Adicionar um novo plano para a equipa

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

Parâmetros

Devoluções

Eliminar o plano especificado

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

Parâmetros

Devoluções

Eliminar a iteração de uma equipa por iterationId

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

Parâmetros

Devoluções

Obter um nível de atraso

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

Parâmetros

Devoluções

Obtém a configuração do atraso de uma equipa

function getBacklogConfigurations(teamContext: TeamContext): Promise<BacklogConfiguration>

Parâmetros

Devoluções

Obter uma lista de itens de trabalho dentro de um nível de atraso

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

Parâmetros

Devoluções

Listar todos os níveis de tarefas pendentes

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

Parâmetros

Devoluções

Obter quadro

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

Parâmetros

Devoluções

Obtém um distintivo que apresenta o estado das colunas no quadro.

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

Parâmetros

Devoluções

Obtém um distintivo que apresenta o estado das colunas no quadro.

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

Parâmetros

Devoluções

Obter definições de Regra do cartão de quadro para o ID de quadro ou quadro pelo nome

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

Parâmetros

Devoluções

Obter definições de cartão de tabuleiro para o ID de quadro ou quadro pelo nome

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

Parâmetros

Devoluções

Obter um gráfico de quadros

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

Parâmetros

Devoluções

Obter gráficos de quadros

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

Parâmetros

Devoluções

Obter colunas num quadro

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

Parâmetros

Devoluções

Devolve a lista do modelo de filtro de campo principal para a lista de IDs de itens de trabalho indicados

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

Parâmetros

Devoluções

Obter linhas num quadro

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

Parâmetros

Devoluções

Obter quadros

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

Parâmetros

Devoluções

Obter definições de utilizador de quadro para um ID de quadro

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

Parâmetros

Devoluções

Obter a capacidade de uma equipa, incluindo capacidade total e dias de folga

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

Parâmetros

Devoluções

Obter a capacidade de um membro da equipa

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Obter colunas de quadro disponíveis num projeto

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

Parâmetros

Devoluções

Obter Dados da Vista de Entrega

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

Parâmetros

Devoluções

Obter itens de trabalho para iteração

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

Parâmetros

Devoluções

Obter as informações do plano especificado

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

Parâmetros

Devoluções

Obter as informações de todos os planos configurados para a equipa especificada

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

Parâmetros

Devoluções

Obter a configuração do processo

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

Parâmetros

Devoluções

Obter linhas de quadro disponíveis num projeto

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

Parâmetros

Devoluções

Obter os dias de folga da equipa para uma iteração

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

Parâmetros

Devoluções

Obter uma coleção de valores de campos de equipa

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

Parâmetros

Devoluções

Obter a iteração da equipa por iterationId

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

Parâmetros

Devoluções

Obter as iterações de uma equipa com o filtro de período de tempo

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

Parâmetros

Devoluções

Obter as definições de uma equipa

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

Parâmetros

Devoluções

Obter a capacidade de uma iteração para todas as equipas em iteração

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Adicionar uma iteração à equipa

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

Parâmetros

Devoluções

Reordenar Itens de Trabalho de Tarefas Pendentes/Quadros do Produto

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

Parâmetros

Devoluções

Reordenar o Sprint Backlog/Itens de Trabalho do Quadro de Tarefas

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

Parâmetros

Devoluções

Substituir a capacidade de uma equipa

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

Parâmetros

Devoluções

Opções do quadro de atualização

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

Parâmetros

Devoluções

Cria/atualiza as definições de regras de automatização

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

Parâmetros

Devoluções

Atualizar as definições da Regra do cartão de quadro para o ID de quadro ou quadro por nome

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

Parâmetros

Devoluções

Atualizar as definições do cartão de quadro para o ID do quadro ou quadro pelo nome

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

Parâmetros

Devoluções

Atualizar um gráfico de quadros

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

Parâmetros

Devoluções

Atualizar colunas num quadro

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

Parâmetros

Devoluções

Atualizar linhas num quadro

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

Parâmetros

Devoluções

Atualizar as definições de utilizador do quadro para o ID do quadro

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

Parâmetros

Devoluções

Atualizar a capacidade de um membro da equipa

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Atualizar as informações do plano especificado

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

Parâmetros

Devoluções

Atualizar as definições da Regra do cartão de quadro de tarefas

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

Parâmetros

Devoluções

Atualizar as definições do cartão de quadro de tarefas

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

Parâmetros

Devoluções

Definir os dias de folga de uma equipa para uma iteração

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

Parâmetros

Devoluções

Atualizar valores de campos de equipa

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

Parâmetros

Devoluções

Atualizar as definições de uma equipa

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções