Compartilhar via


WorkRestClient class

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

Construtores

WorkRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createPlan(CreatePlan, string)

Adicionar um novo plano para a equipe

deletePlan(string, string)

Excluir o plano especificado

deleteTeamIteration(TeamContext, string)

Excluir a iteração de uma equipe por iteraçãoId

getBacklog(TeamContext, string)

Obter um nível de lista de pendências

getBacklogConfigurations(TeamContext)

Obtém a configuração de lista de pendências para uma equipe

getBacklogLevelWorkItems(TeamContext, string)

Obter uma lista de itens de trabalho em um nível de lista de pendências

getBacklogs(TeamContext)

Listar todos os níveis de lista de pendências

getBoard(TeamContext, string)

Obter quadro

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

Obtém um selo que exibe o status de colunas no quadro.

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

Obtém um selo que exibe o status de colunas no quadro.

getBoardCardRuleSettings(TeamContext, string)

Obter configurações de regra de cartão de quadro para a ID do quadro ou quadro por nome

getBoardCardSettings(TeamContext, string)

Obter configurações de cartão de quadro para a ID do quadro ou o 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 em um quadro

getBoardMappingParentItems(TeamContext, string, number[])

Retorna a lista do modelo de filtro de campo pai para a lista especificada de IDs de workitem

getBoardRows(TeamContext, string)

Obter linhas em um quadro

getBoards(TeamContext)

Obter quadros

getBoardUserSettings(TeamContext, string)

Obter configurações de usuário do quadro para uma ID de quadro

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

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

getCapacityWithIdentityRef(TeamContext, string, string)

Obter a capacidade de um membro da equipe

getColumns(TeamContext)
getColumnSuggestedValues(string)

Obter colunas de quadro disponíveis em um projeto

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

Obter dados de exibição 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 equipe fornecida

getProcessConfiguration(string)

Obter configuração do processo

getRowSuggestedValues(string)

Obter linhas de quadro disponíveis em um projeto

getTeamDaysOff(TeamContext, string)

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

getTeamFieldValues(TeamContext)

Obter uma coleção de valores de campo de equipe

getTeamIteration(TeamContext, string)

Obter a iteração da equipe por iteraçãoId

getTeamIterations(TeamContext, string)

Obter iterações de uma equipe usando o filtro de período de tempo

getTeamSettings(TeamContext)

Obter as configurações de uma equipe

getTotalIterationCapacities(string, string)

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

getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)

Adicionar uma iteração à equipe

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Reordenar itens de trabalho de lista de pendências/quadros de produtos

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Reordenar itens de trabalho do Sprint Backlog/Taskboard

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Substituir a capacidade de uma equipe

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

Opções de quadro de atualização

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Cria/atualiza as configurações de regras de automação

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Atualizar o quadro cartão Configurações de regra para a ID do quadro ou quadro por nome

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Atualizar as configurações de cartão do quadro para a ID do quadro ou o quadro por nome

updateBoardChart(BoardChart, TeamContext, string, string)

Atualizar um gráfico de quadros

updateBoardColumns(BoardColumn[], TeamContext, string)

Atualizar colunas em um quadro

updateBoardRows(BoardRow[], TeamContext, string)

Atualizar linhas em um quadro

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

Atualizar as configurações de usuário do quadro para a ID do quadro

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Atualizar a capacidade de um membro da equipe

updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)

Atualizar as informações do plano especificado

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Atualizar configurações de regra de cartão do quadro de tarefas

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Atualizar configurações de cartão do quadro de tarefas

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

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

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Atualizar valores de campo de equipe

updateTeamSettings(TeamSettingsPatch, TeamContext)

Atualizar as configurações de uma equipe

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Detalhes do construtor

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

createPlan(CreatePlan, string)

Adicionar um novo plano para a equipe

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

Retornos

Promise<Plan>

deletePlan(string, string)

Excluir 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

Retornos

Promise<void>

deleteTeamIteration(TeamContext, string)

Excluir a iteração de uma equipe por iteraçãoId

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

id

string

ID da iteração

Retornos

Promise<void>

getBacklog(TeamContext, string)

Obter um nível de lista de pendências

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

id

string

A ID do nível de lista de pendências

Retornos

getBacklogConfigurations(TeamContext)

Obtém a configuração de lista de pendências para uma equipe

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

getBacklogLevelWorkItems(TeamContext, string)

Obter uma lista de itens de trabalho em um nível de lista de pendências

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

backlogId

string

Retornos

getBacklogs(TeamContext)

Listar todos os níveis de lista de pendências

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

getBoard(TeamContext, string)

Obter quadro

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

id

string

identificador para board, nome de nível de lista de pendências do quadro (por exemplo: "Histórias") ou ID

Retornos

Promise<Board>

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

Obtém um selo que exibe o status de colunas no quadro.

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

id

string

A ID do quadro.

columnOptions
BoardBadgeColumnOptions

Determina quais colunas mostrar.

columns

string[]

Se columnOptions for definido como personalizado, especifique a lista de nomes de coluna.

Retornos

Promise<BoardBadge>

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

Obtém um selo que exibe o status de colunas no quadro.

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

id

string

A ID do quadro.

columnOptions
BoardBadgeColumnOptions

Determina quais colunas mostrar.

columns

string[]

Se columnOptions for definido como personalizado, especifique a lista de nomes de coluna.

Retornos

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Obter configurações de regra de cartão de quadro para a ID do quadro ou quadro por nome

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

board

string

Retornos

getBoardCardSettings(TeamContext, string)

Obter configurações de cartão de quadro para a ID do quadro ou o quadro pelo nome

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

board

string

Retornos

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 equipe para a operação

board

string

Identificador do quadro, nome do nível de lista de pendências do quadro (por exemplo: "Histórias") ou ID

name

string

O nome do gráfico

Retornos

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 equipe para a operação

board

string

Identificador do quadro, nome do nível de lista de pendências do quadro (por exemplo: "Histórias") ou ID

Retornos

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Obter colunas em um quadro

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

board

string

Nome ou ID do quadro específico

Retornos

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Retorna a lista do modelo de filtro de campo pai para a lista especificada de IDs de workitem

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

childBacklogContextCategoryRefName

string

workitemIds

number[]

Retornos

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Obter linhas em um quadro

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

board

string

Nome ou ID do quadro específico

Retornos

Promise<BoardRow[]>

getBoards(TeamContext)

Obter quadros

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Obter configurações de usuário do quadro para uma ID de quadro

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

board

string

ID ou nome do quadro

Retornos

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

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

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

ID da iteração

Retornos

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Obter a capacidade de um membro da equipe

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

ID da iteração

teamMemberId

string

ID do membro da equipe

Retornos

getColumns(TeamContext)

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Obter colunas de quadro disponíveis em um projeto

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

Promise<BoardSuggestedValue[]>

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

Obter dados de exibição 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 exibição de entrega

revision

number

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

startDate

Date

A data de início do linha do tempo

endDate

Date

A data de término do linha do tempo

Retornos

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 equipe para a operação

iterationId

string

ID da iteração

Retornos

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

Retornos

Promise<Plan>

getPlans(string)

Obter as informações de todos os planos configurados para a equipe fornecida

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

Promise<Plan[]>

getProcessConfiguration(string)

Obter configuração do processo

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

getRowSuggestedValues(string)

Obter linhas de quadro disponíveis em um projeto

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

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

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

ID da iteração

Retornos

getTeamFieldValues(TeamContext)

Obter uma coleção de valores de campo de equipe

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Obter a iteração da equipe por iteraçãoId

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

id

string

ID da iteração

Retornos

getTeamIterations(TeamContext, string)

Obter iterações de uma equipe usando o filtro de período de tempo

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

timeframe

string

Um filtro para o qual as iterações são retornadas com base no tempo relativo. Somente o Current tem suporte no momento.

Retornos

getTeamSettings(TeamContext)

Obter as configurações de uma equipe

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Obter a capacidade de uma iteração para todas as equipes 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

Retornos

getWorkItemColumns(TeamContext, string)

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

Retornos

postTeamIteration(TeamSettingsIteration, TeamContext)

Adicionar uma iteração à equipe

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

Parâmetros

iteration
TeamSettingsIteration

Iteração a ser adicionada

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Reordenar itens de trabalho de lista de pendências/quadros de produtos

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

Parâmetros

operation
ReorderOperation
teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Reordenar itens de trabalho do Sprint Backlog/Taskboard

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

Parâmetros

operation
ReorderOperation
teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

A ID da iteração

Retornos

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Substituir a capacidade de uma equipe

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

Parâmetros

capacities

TeamMemberCapacityIdentityRef[]

Capacidade da equipe para substituir

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

ID da iteração

Retornos

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

Opções de 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 serem atualizadas

teamContext
TeamContext

O contexto da equipe para a operação

id

string

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

Retornos

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Cria/atualiza as configurações de regras de automação

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

Parâmetros

ruleRequestModel
TeamAutomationRulesSettingsRequestModel

Parâmetros necessários para criar/atualizar as configurações de regras de automação

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Atualizar o quadro cartão Configurações de regra para a ID do quadro ou quadro por nome

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

Parâmetros

boardCardRuleSettings
BoardCardRuleSettings
teamContext
TeamContext

O contexto da equipe para a operação

board

string

Retornos

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Atualizar as configurações de cartão do quadro para a ID do quadro ou o quadro por nome

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

Parâmetros

boardCardSettingsToSave
BoardCardSettings
teamContext
TeamContext

O contexto da equipe para a operação

board

string

Retornos

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 equipe para a operação

board

string

Identificador para placa, nome de nível de lista de pendências (por exemplo: "Histórias") ou ID

name

string

O nome do gráfico

Retornos

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Atualizar colunas em um quadro

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

Parâmetros

boardColumns

BoardColumn[]

Lista de colunas de quadro a serem atualizadas

teamContext
TeamContext

O contexto da equipe para a operação

board

string

Nome ou ID do quadro específico

Retornos

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Atualizar linhas em um quadro

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

Parâmetros

boardRows

BoardRow[]

Lista de linhas de quadro a serem atualizadas

teamContext
TeamContext

O contexto da equipe para a operação

board

string

Nome ou ID do quadro específico

Retornos

Promise<BoardRow[]>

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

Atualizar as configurações de usuário do quadro para a 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 equipe para a operação

board

string

Retornos

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Atualizar a capacidade de um membro da equipe

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

Parâmetros

patch
CapacityPatch

Capacidade atualizada

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

ID da iteração

teamMemberId

string

ID do membro da equipe

Retornos

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parâmetros

updateColumns

UpdateTaskboardColumn[]

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

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

Planejar a definição a ser atualizada

project

string

ID do projeto ou nome do projeto

id

string

Identificador do plano

Retornos

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Atualizar configurações de regra de cartão do quadro de tarefas

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

Parâmetros

boardCardRuleSettings
BoardCardRuleSettings
teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Atualizar configurações de cartão do quadro de tarefas

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

Parâmetros

boardCardSettingsToSave
BoardCardSettings
teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

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

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

Parâmetros

daysOffPatch
TeamSettingsDaysOffPatch

Patch de dias de folga da equipe que contém uma lista de datas de início e término

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

ID da iteração

Retornos

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Atualizar valores de campo de equipe

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Atualizar as configurações de uma equipe

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

Parâmetros

teamSettingsPatch
TeamSettingsPatch

Alterações de TeamSettings

teamContext
TeamContext

O contexto da equipe para a operação

Retornos

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parâmetros

teamContext
TeamContext

O contexto da equipe para a operação

iterationId

string

workItemId

number

Retornos

Promise<void>