WorkRestClient class

Pacote:: azure-devops-extension-api

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

Extends: RestClientBase

Construtores

Propriedades

Métodos

createPlan(CreatePlan, string)	Adicionar um novo plano para a equipa
deletePlan(string, string)	Excluir o plano especificado
deleteTeamIteration(TeamContext, string)	Excluir a iteração de uma equipe por iterationId
getBacklog(TeamContext, string)	Obter um nível de lista de pendências
getBacklogConfigurations(TeamContext)	Obtém a configuração da lista de pendências para uma equipe
getBacklogLevelWorkItems(TeamContext, string)	Obter uma lista de itens de trabalho dentro de um nível de lista de pendências
getBacklogs(TeamContext)	Listar todos os níveis de lista de pendências
getBoard(TeamContext, string)	Obter placa
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtém um selo que exibe o status das colunas no quadro.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtém um selo que exibe o status das colunas no quadro.
getBoardCardRuleSettings(TeamContext, string)	Obter cartão de placa Configurações de regra para o ID do quadro ou quadro por nome
getBoardCardSettings(TeamContext, string)	Obter configurações de cartão de placa para o ID do conselho ou placa por nome
getBoardChart(TeamContext, string, string)	Obter um gráfico do quadro
getBoardCharts(TeamContext, string)	Obter gráficos do quadro
getBoardColumns(TeamContext, string)	Obter colunas em um quadro
getBoardMappingParentItems(TeamContext, string, number[])	Retorna a lista de modelo de filtro de campo pai para a lista determinada de ids de item de trabalho
getBoardRows(TeamContext, string)	Obter linhas em um quadro
getBoards(TeamContext)	Obter placas
getBoardUserSettings(TeamContext, string)	Obter configurações de usuário do quadro para um ID do quadro
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Obtenha a capacidade de uma equipe, 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 em um projeto
getDeliveryTimelineData(string, string, number, Date, Date)	Obter dados de visualização de entrega
getIterationWorkItems(TeamContext, string)	Obter itens de trabalho para iteração
getPlan(string, string)	Obter as informações para o plano especificado
getPlans(string)	Obter as informações de todos os planos configurados para determinada equipe
getProcessConfiguration(string)	Obter configuração do processo
getRowSuggestedValues(string)	Obter linhas de quadro disponíveis em um projeto
getTeamDaysOff(TeamContext, string)	Obtenha 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 iteração da equipe por iterationId
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 à equipa
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Reordenar itens de trabalho de backlog/placas de produtos
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Reordenar itens de trabalho da lista de pendências/quadro de tarefas da Sprint
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Substitua a capacidade de uma equipe
setBoardOptions({[key: string]: string}, TeamContext, string)	Atualizar opções do quadro
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Cria/atualiza uma configuração de regras de automação
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Atualizar cartão de placa Configurações de regra para o ID do quadro ou quadro por nome
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Atualizar as configurações do cartão do conselho para o ID do quadro ou do quadro por nome
updateBoardChart(BoardChart, TeamContext, string, string)	Atualizar um gráfico do quadro
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 do usuário do quadro para o 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 as configurações da regra do cartão de tarefas
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Atualizar as configurações do 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 da 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

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)

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

Devoluções

Promise<void>

deleteTeamIteration(TeamContext, string)

Excluir a iteração de uma equipe por iterationId

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

Devoluções

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 da lista de pendências

Devoluções

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Obtém a configuração da 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

Devoluções

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Obter uma lista de itens de trabalho dentro de 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

Devoluções

Promise<BacklogLevelWorkItems>

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

Devoluções

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Obter placa

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

Parâmetros

teamContext: TeamContext

O contexto da equipe para a operação

id: string

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

Devoluções

Promise<Board>

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

Obtém um selo que exibe o status das 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

O id do quadro.

columnOptions: BoardBadgeColumnOptions

Determina quais colunas mostrar.

columns: string[]

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

Devoluções

Promise<BoardBadge>

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

Obtém um selo que exibe o status das 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

O id do quadro.

columnOptions: BoardBadgeColumnOptions

Determina quais colunas mostrar.

columns: string[]

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

Devoluções

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Obter cartão de placa Configurações de regra para o 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

Devoluções

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Obter configurações de cartão de placa para o ID do conselho ou placa por nome

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

Parâmetros

teamContext: TeamContext

O contexto da equipe para a operação

board: string

Devoluções

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Obter um gráfico do quadro

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 da lista de pendências 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 do quadro

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 da lista de pendências do quadro (por exemplo: "Histórias") ou Id

Devoluções

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 conselho específico

Devoluções

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Retorna a lista de modelo de filtro de campo pai para a lista determinada de ids de item de trabalho

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[]

Devoluções

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 conselho específico

Devoluções

Promise<BoardRow[]>

getBoards(TeamContext)

Obter placas

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

Parâmetros

teamContext: TeamContext

O contexto da equipe para a operação

Devoluções

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Obter configurações de usuário do quadro para um ID do 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 da placa

Devoluções

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Obtenha 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

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

Devoluções

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

Devoluções

Promise<BoardSuggestedValue[]>

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

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

revision: number

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

startDate: Date

A data de início da linha do tempo

endDate: Date

A data final da linha do tempo

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

iterationId: string

ID da iteração

Devoluções

Promise<IterationWorkItems>

getPlan(string, string)

Obter as informações para o 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 determinada equipe

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Devoluções

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

Devoluções

Promise<ProcessConfiguration>

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

Devoluções

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Obtenha 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

Devoluções

Promise<TeamSettingsDaysOff>

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

Devoluções

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Obter iteração da equipe por iterationId

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

Devoluções

Promise<TeamSettingsIteration>

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. Atualmente, apenas Atual é suportado.

Devoluções

Promise<TeamSettingsIteration[]>

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

Devoluções

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

Devoluções

Promise<IterationCapacity>

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

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

Devoluções

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Reordenar itens de trabalho de backlog/placas de produtos

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

Parâmetros

operation: ReorderOperation

teamContext: TeamContext

O contexto da equipe para a operação

Devoluções

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Reordenar itens de trabalho da lista de pendências/quadro de tarefas da Sprint

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

O id da iteração

Devoluções

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Substitua a capacidade de uma equipe

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

Parâmetros

capacities: TeamMemberCapacityIdentityRef[]

Capacidade da equipa para substituir

teamContext: TeamContext

O contexto da equipe para a operação

iterationId: string

ID da iteração

Devoluções

Promise<TeamMemberCapacityIdentityRef[]>

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

Atualizar opções do quadro

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

Parâmetros

options: {[key: string]: string}

opções para atualizar

teamContext: TeamContext

O contexto da equipe 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 uma configuração de regras de automação

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

Parâmetros

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

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

teamContext: TeamContext

O contexto da equipe para a operação

Devoluções

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Atualizar cartão de placa Configurações de regra para o 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

Devoluções

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Atualizar as configurações do cartão do conselho para o ID do quadro ou do 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

Devoluções

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Atualizar um gráfico do quadro

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 do quadro, nome do nível da lista de pendências 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 em um quadro

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

Parâmetros

boardColumns: BoardColumn[]

Lista de colunas do quadro a atualizar

teamContext: TeamContext

O contexto da equipe para a operação

board: string

Nome ou ID do conselho específico

Devoluções

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 do quadro a serem atualizadas

teamContext: TeamContext

O contexto da equipe para a operação

board: string

Nome ou ID do conselho específico

Devoluções

Promise<BoardRow[]>

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

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

board: string

Devoluções

Promise<BoardUserSettings>

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 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 equipe 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 ser atualizado

project: string

ID do projeto ou nome do projeto

id: string

Identificador do plano

Devoluções

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

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

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

Parâmetros

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

O contexto da equipe para a operação

Devoluções

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Atualizar as configurações do 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

Devoluções

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 equipa contendo uma lista de datas de início e fim

teamContext: TeamContext

O contexto da equipe para a operação

iterationId: string

ID da iteração

Devoluções

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Atualizar valores de campo da equipe

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

Parâmetros

patch: TeamFieldValuesPatch

teamContext: TeamContext

O contexto da equipe para a operação

Devoluções

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 nas configurações da equipe

teamContext: TeamContext

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

iterationId: string

workItemId: number

Devoluções

Promise<void>

Comentários

Esta página foi útil?

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