WorkRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends: RestClientBase

Construtores

WorkRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createPlan(CreatePlan, string)	Adicionar um novo plano para a equipa
deletePlan(string, string)	Eliminar o plano especificado
deleteTeamIteration(TeamContext, string)	Eliminar a iteração de uma equipa por iterationId
getBacklog(TeamContext, string)	Obter um nível de atraso
getBacklogConfigurations(TeamContext)	Obtém a configuração do atraso de uma equipa
getBacklogLevelWorkItems(TeamContext, string)	Obter uma lista de itens de trabalho dentro de um nível de atraso
getBacklogs(TeamContext)	Listar todos os níveis de tarefas pendentes
getBoard(TeamContext, string)	Obter quadro
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtém um distintivo que apresenta o estado das colunas no quadro.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtém um distintivo que apresenta o estado das colunas no quadro.
getBoardCardRuleSettings(TeamContext, string)	Obter definições de Regra do cartão de quadro para o ID de quadro ou quadro pelo nome
getBoardCardSettings(TeamContext, string)	Obter definições de cartão de tabuleiro para o ID de quadro ou quadro pelo nome
getBoardChart(TeamContext, string, string)	Obter um gráfico de quadros
getBoardCharts(TeamContext, string)	Obter gráficos de quadros
getBoardColumns(TeamContext, string)	Obter colunas num quadro
getBoardMappingParentItems(TeamContext, string, number[])	Devolve a lista do modelo de filtro de campo principal para a lista de IDs de itens de trabalho indicados
getBoardRows(TeamContext, string)	Obter linhas num quadro
getBoards(TeamContext)	Obter quadros
getBoardUserSettings(TeamContext, string)	Obter definições de utilizador de quadro para um ID de quadro
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Obter a capacidade de uma equipa, incluindo capacidade total e dias de folga
getCapacityWithIdentityRef(TeamContext, string, string)	Obter a capacidade de um membro da equipa
getColumns(TeamContext)
getColumnSuggestedValues(string)	Obter colunas de quadro disponíveis num projeto
getDeliveryTimelineData(string, string, number, Date, Date)	Obter Dados da Vista de Entrega
getIterationWorkItems(TeamContext, string)	Obter itens de trabalho para iteração
getPlan(string, string)	Obter as informações do plano especificado
getPlans(string)	Obter as informações de todos os planos configurados para a equipa especificada
getProcessConfiguration(string)	Obter a configuração do processo
getRowSuggestedValues(string)	Obter linhas de quadro disponíveis num projeto
getTeamDaysOff(TeamContext, string)	Obter os dias de folga da equipa para uma iteração
getTeamFieldValues(TeamContext)	Obter uma coleção de valores de campos de equipa
getTeamIteration(TeamContext, string)	Obter a iteração da equipa por iterationId
getTeamIterations(TeamContext, string)	Obter as iterações de uma equipa com o filtro de período de tempo
getTeamSettings(TeamContext)	Obter as definições de uma equipa
getTotalIterationCapacities(string, string)	Obter a capacidade de uma iteração para todas as equipas em iteração
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Adicionar uma iteração à equipa
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Reordenar Itens de Trabalho de Tarefas Pendentes/Quadros do Produto
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Reordenar o Sprint Backlog/Itens de Trabalho do Quadro de Tarefas
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Substituir a capacidade de uma equipa
setBoardOptions({[key: string]: string}, TeamContext, string)	Opções do quadro de atualização
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Cria/atualiza as definições de regras de automatização
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Atualizar as definições da Regra do cartão de quadro para o ID de quadro ou quadro por nome
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Atualizar as definições do cartão de quadro para o ID do quadro ou quadro pelo nome
updateBoardChart(BoardChart, TeamContext, string, string)	Atualizar um gráfico de quadros
updateBoardColumns(BoardColumn[], TeamContext, string)	Atualizar colunas num quadro
updateBoardRows(BoardRow[], TeamContext, string)	Atualizar linhas num quadro
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Atualizar as definições de utilizador do quadro para o ID do quadro
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Atualizar a capacidade de um membro da equipa
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Atualizar as informações do plano especificado
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Atualizar as definições da Regra do cartão de quadro de tarefas
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Atualizar as definições do cartão de quadro de tarefas
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Definir os dias de folga de uma equipa para uma iteração
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Atualizar valores de campos de equipa
updateTeamSettings(TeamSettingsPatch, TeamContext)	Atualizar as definições de uma equipa
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Detalhes do Construtor

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

createPlan(CreatePlan, string)

Adicionar um novo plano para a equipa

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

Parâmetros

postedPlan: CreatePlan

Definição do plano

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<Plan>

deletePlan(string, string)

Eliminar o plano especificado

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

id: string

Identificador do plano

Devoluções

Promise<void>

deleteTeamIteration(TeamContext, string)

Eliminar a iteração de uma equipa por iterationId

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

id: string

ID da iteração

Devoluções

Promise<void>

getBacklog(TeamContext, string)

Obter um nível de atraso

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

id: string

O ID do nível de caixa de tarefas pendentes

Devoluções

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

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

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

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

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

backlogId: string

Devoluções

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Listar todos os níveis de tarefas pendentes

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Obter quadro

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

id: string

identificador do quadro, nome do nível do registo de tarefas pendentes do quadro (Por exemplo: "Histórias") ou ID

Devoluções

Promise<Board>

getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])

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

teamContext: TeamContext

O contexto da equipa para a operação

id: string

O ID do quadro.

columnOptions: BoardBadgeColumnOptions

Determina as colunas a mostrar.

columns: string[]

Se columnOptions estiver definido como personalizado, especifique a lista de nomes de colunas.

Devoluções

Promise<BoardBadge>

getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])

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

teamContext: TeamContext

O contexto da equipa para a operação

id: string

O ID do quadro.

columnOptions: BoardBadgeColumnOptions

Determina as colunas a mostrar.

columns: string[]

Se columnOptions estiver definido como personalizado, especifique a lista de nomes de colunas.

Devoluções

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

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

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Devoluções

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

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

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Devoluções

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Obter um gráfico de quadros

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Identificador do quadro, nome do nível do registo de tarefas pendentes do quadro (Por exemplo: "Histórias") ou ID

name: string

O nome do gráfico

Devoluções

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Obter gráficos de quadros

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Identificador do quadro, nome do nível do registo de tarefas pendentes do quadro (Por exemplo: "Histórias") ou ID

Devoluções

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Obter colunas num quadro

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Nome ou ID do quadro específico

Devoluções

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

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

teamContext: TeamContext

O contexto da equipa para a operação

childBacklogContextCategoryRefName: string

workitemIds: number[]

Devoluções

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Obter linhas num quadro

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Nome ou ID do quadro específico

Devoluções

Promise<BoardRow[]>

getBoards(TeamContext)

Obter quadros

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

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

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Nome ou ID do Quadro

Devoluções

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

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

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

Devoluções

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Obter a capacidade de um membro da equipa

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

teamMemberId: string

ID do membro da equipa

Devoluções

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Obter colunas de quadro disponíveis num projeto

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<BoardSuggestedValue[]>

getDeliveryTimelineData(string, string, number, Date, Date)

Obter Dados da Vista de Entrega

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

id: string

Identificador para a vista de entrega

revision: number

Revisão do plano para o qual pretende obter dados. Se o plano atual for uma revisão diferente, obterá uma exceção ViewRevisionMismatchException. Se não fornecer uma revisão, obterá dados para a revisão mais recente.

startDate: Date

A data de início da linha cronológica

endDate: Date

A data de fim da linha cronológica

Devoluções

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Obter itens de trabalho para iteração

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

Devoluções

Promise<IterationWorkItems>

getPlan(string, string)

Obter as informações do plano especificado

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

id: string

Identificador do plano

Devoluções

Promise<Plan>

getPlans(string)

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

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<Plan[]>

getProcessConfiguration(string)

Obter a configuração do processo

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Obter linhas de quadro disponíveis num projeto

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

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

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

Devoluções

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

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

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Obter a iteração da equipa por iterationId

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

id: string

ID da iteração

Devoluções

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

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

teamContext: TeamContext

O contexto da equipa para a operação

timeframe: string

Um filtro para o qual as iterações são devolvidas com base no tempo relativo. Apenas Atual é suportado atualmente.

Devoluções

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Obter as definições de uma equipa

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

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

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

iterationId: string

ID da iteração

Devoluções

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parâmetros

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

Devoluções

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Adicionar uma iteração à equipa

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

Parâmetros

iteration: TeamSettingsIteration

Iteração a adicionar

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Reordenar Itens de Trabalho de Tarefas Pendentes/Quadros do Produto

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

Parâmetros

operation: ReorderOperation

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

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

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

Parâmetros

operation: ReorderOperation

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

O ID da iteração

Devoluções

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Substituir a capacidade de uma equipa

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

Parâmetros

capacities: TeamMemberCapacityIdentityRef[]

Capacidade de equipa a substituir

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

Devoluções

Promise<TeamMemberCapacityIdentityRef[]>

setBoardOptions({[key: string]: string}, TeamContext, string)

Opções do quadro de atualização

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

Parâmetros

options: {[key: string]: string}

opções a atualizar

teamContext: TeamContext

O contexto da equipa para a operação

id: string

identificador para quadro, nome plural da categoria (por exemplo: "Histórias") ou guid

Devoluções

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

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

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

Parâmetros

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Parâmetros necessários para criar/atualizar definições de regras de automatização

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

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

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Devoluções

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

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

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Devoluções

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Atualizar um gráfico de quadros

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

Parâmetros

chart: BoardChart

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Identificador do quadro, nome do nível do registo de tarefas pendentes do quadro (Por exemplo: "Histórias") ou ID

name: string

O nome do gráfico

Devoluções

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Atualizar colunas num quadro

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

Parâmetros

boardColumns: BoardColumn[]

Lista de colunas de quadro a atualizar

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Nome ou ID do quadro específico

Devoluções

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Atualizar linhas num quadro

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

Parâmetros

boardRows: BoardRow[]

Lista de linhas de quadro a atualizar

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Nome ou ID do quadro específico

Devoluções

Promise<BoardRow[]>

updateBoardUserSettings({[key: string]: string}, TeamContext, string)

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

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

O contexto da equipa para a operação

board: string

Devoluções

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Atualizar a capacidade de um membro da equipa

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

Parâmetros

patch: CapacityPatch

Capacidade atualizada

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

teamMemberId: string

ID do membro da equipa

Devoluções

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parâmetros

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Atualizar as informações do plano especificado

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

Parâmetros

updatedPlan: UpdatePlan

Definição do plano a atualizar

project: string

ID do Projeto ou nome do projeto

id: string

Identificador do plano

Devoluções

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

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

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

Parâmetros

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

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

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

Parâmetros

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

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

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

Parâmetros

daysOffPatch: TeamSettingsDaysOffPatch

Patch de dias de folga da equipa que contém uma lista de datas de início e de fim

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

ID da iteração

Devoluções

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Atualizar valores de campos de equipa

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

Parâmetros

patch: TeamFieldValuesPatch

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Atualizar as definições de uma equipa

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

Parâmetros

teamSettingsPatch: TeamSettingsPatch

Alterações de TeamSettings

teamContext: TeamContext

O contexto da equipa para a operação

Devoluções

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parâmetros

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

O contexto da equipa para a operação

iterationId: string

workItemId: number

Devoluções

Promise<void>

Partilhar via

WorkRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

WorkRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

createPlan(CreatePlan, string)

Parâmetros

Devoluções

deletePlan(string, string)

Parâmetros

Devoluções

deleteTeamIteration(TeamContext, string)

Parâmetros

Devoluções

getBacklog(TeamContext, string)

Parâmetros

Devoluções

getBacklogConfigurations(TeamContext)

Parâmetros

Devoluções

getBacklogLevelWorkItems(TeamContext, string)

Parâmetros

Devoluções

getBacklogs(TeamContext)

Parâmetros

Devoluções

getBoard(TeamContext, string)

Parâmetros

Devoluções

getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])

Parâmetros

Devoluções

getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])

Parâmetros

Devoluções

getBoardCardRuleSettings(TeamContext, string)

Parâmetros

Devoluções

getBoardCardSettings(TeamContext, string)

Parâmetros

Devoluções

getBoardChart(TeamContext, string, string)

Parâmetros

Devoluções

getBoardCharts(TeamContext, string)

Parâmetros

Devoluções

getBoardColumns(TeamContext, string)

Parâmetros

Devoluções

getBoardMappingParentItems(TeamContext, string, number[])

Parâmetros

Devoluções

getBoardRows(TeamContext, string)

Parâmetros

Devoluções

getBoards(TeamContext)

Parâmetros

Devoluções

getBoardUserSettings(TeamContext, string)

Parâmetros

Devoluções

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parâmetros

Devoluções

getCapacityWithIdentityRef(TeamContext, string, string)

Parâmetros

Devoluções

getColumns(TeamContext)

Parâmetros

Devoluções

getColumnSuggestedValues(string)

Parâmetros