WorkRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends: RestClientBase

Costruttori

WorkRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

createPlan(CreatePlan, string)	Aggiungere un nuovo piano per il team
deletePlan(string, string)	Eliminare il piano specificato
deleteTeamIteration(TeamContext, string)	Eliminare l'iterazione di un team in base all'iterazioneId
getBacklog(TeamContext, string)	Ottenere un livello di backlog
getBacklogConfigurations(TeamContext)	Ottiene la configurazione del backlog per un team
getBacklogLevelWorkItems(TeamContext, string)	Ottenere un elenco di elementi di lavoro all'interno di un livello backlog
getBacklogs(TeamContext)	Elencare tutti i livelli di backlog
getBoard(TeamContext, string)	Get board
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Ottiene un badge che visualizza lo stato delle colonne sulla scheda.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Ottiene un badge che visualizza lo stato delle colonne sulla scheda.
getBoardCardRuleSettings(TeamContext, string)	Ottenere le impostazioni delle regole della scheda scheda per l'ID scheda o la scheda in base al nome
getBoardCardSettings(TeamContext, string)	Ottenere le impostazioni della scheda scheda per l'ID della scheda o della scheda in base al nome
getBoardChart(TeamContext, string, string)	Ottenere un grafico a bordo
getBoardCharts(TeamContext, string)	Ottenere grafici a schede
getBoardColumns(TeamContext, string)	Ottenere colonne su una scheda
getBoardMappingParentItems(TeamContext, string, number[])	Restituisce l'elenco del modello di filtro del campo padre per l'elenco specificato di ID dell'elemento di lavoro
getBoardRows(TeamContext, string)	Ottenere righe su una scheda
getBoards(TeamContext)	Ottenere schede
getBoardUserSettings(TeamContext, string)	Ottenere le impostazioni utente della scheda per un ID scheda
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Ottenere la capacità di un team, inclusa la capacità totale e i giorni di disattivazione
getCapacityWithIdentityRef(TeamContext, string, string)	Ottenere la capacità di un membro del team
getColumns(TeamContext)
getColumnSuggestedValues(string)	Ottenere le colonne della scheda disponibili in un progetto
getDeliveryTimelineData(string, string, number, Date, Date)	Ottenere i dati della visualizzazione recapito
getIterationWorkItems(TeamContext, string)	Ottenere elementi di lavoro per l'iterazione
getPlan(string, string)	Ottenere le informazioni per il piano specificato
getPlans(string)	Ottenere le informazioni per tutti i piani configurati per il team specificato
getProcessConfiguration(string)	Ottenere la configurazione del processo
getRowSuggestedValues(string)	Ottenere le righe della scheda disponibili in un progetto
getTeamDaysOff(TeamContext, string)	Ottenere i giorni di attesa del team per un'iterazione
getTeamFieldValues(TeamContext)	Ottenere una raccolta di valori di campo del team
getTeamIteration(TeamContext, string)	Ottenere l'iterazione del team da iterazioneId
getTeamIterations(TeamContext, string)	Ottenere le iterazioni di un team usando il filtro dell'intervallo di tempo
getTeamSettings(TeamContext)	Ottenere le impostazioni di un team
getTotalIterationCapacities(string, string)	Ottenere la capacità di un'iterazione per tutti i team nell'iterazione
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Aggiungere un'iterazione al team
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Riordinare gli elementi di lavoro del prodotto/Schede
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Riordinare gli elementi di lavoro di Sprint Backlog/Taskboard
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Sostituire la capacità di un team
setBoardOptions({[key: string]: string}, TeamContext, string)	Opzioni della scheda di aggiornamento
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Crea/aggiorna le impostazioni delle regole di automazione
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Aggiornare le impostazioni delle regole della scheda scheda per l'ID della scheda o della scheda in base al nome
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Aggiornare le impostazioni della scheda scheda per l'ID della scheda o della scheda in base al nome
updateBoardChart(BoardChart, TeamContext, string, string)	Aggiornare un grafico a scheda
updateBoardColumns(BoardColumn[], TeamContext, string)	Aggiornare le colonne in una scheda
updateBoardRows(BoardRow[], TeamContext, string)	Aggiornare le righe in una scheda
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Aggiornare le impostazioni utente della scheda per l'ID scheda
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Aggiornare la capacità di un membro del team
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Aggiornare le informazioni per il piano specificato
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Aggiornare le impostazioni delle regole della scheda taskboard
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Aggiornare le impostazioni della scheda di taskboard
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Impostare i giorni di attesa di un team per un'iterazione
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Aggiornare i valori dei campi del team
updateTeamSettings(TeamSettingsPatch, TeamContext)	Aggiornare le impostazioni di un team
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Dettagli costruttore

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

createPlan(CreatePlan, string)

Aggiungere un nuovo piano per il team

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

Parametri

postedPlan: CreatePlan

Definizione del piano

project: string

ID progetto o nome progetto

Restituisce

Promise<Plan>

deletePlan(string, string)

Eliminare il piano specificato

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

Parametri

project: string

ID progetto o nome progetto

id: string

Identificatore del piano

Restituisce

Promise<void>

deleteTeamIteration(TeamContext, string)

Eliminare l'iterazione di un team in base all'iterazioneId

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

id: string

ID dell'iterazione

Restituisce

Promise<void>

getBacklog(TeamContext, string)

Ottenere un livello di backlog

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

id: string

ID del livello di backlog

Restituisce

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Ottiene la configurazione del backlog per un team

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Ottenere un elenco di elementi di lavoro all'interno di un livello backlog

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

backlogId: string

Restituisce

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Elencare tutti i livelli di backlog

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Get board

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

id: string

identificatore per la scheda, nome del backlog del backlog della scheda (Eg:"Storie") o ID

Restituisce

Promise<Board>

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

Ottiene un badge che visualizza lo stato delle colonne sulla scheda.

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

id: string

ID della scheda.

columnOptions: BoardBadgeColumnOptions

Determina le colonne da visualizzare.

columns: string[]

Se columnOptions è impostato su personalizzato, specificare l'elenco dei nomi di colonna.

Restituisce

Promise<BoardBadge>

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

Ottiene un badge che visualizza lo stato delle colonne sulla scheda.

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

id: string

ID della scheda.

columnOptions: BoardBadgeColumnOptions

Determina le colonne da visualizzare.

columns: string[]

Se columnOptions è impostato su personalizzato, specificare l'elenco dei nomi di colonna.

Restituisce

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Ottenere le impostazioni delle regole della scheda scheda per l'ID scheda o la scheda in base al nome

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Restituisce

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Ottenere le impostazioni della scheda scheda per l'ID della scheda o della scheda in base al nome

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Restituisce

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Ottenere un grafico a bordo

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Identificatore per la scheda, nome del backlog del backlog della scheda (Eg:"Stories") o ID

name: string

Nome del grafico

Restituisce

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Ottenere grafici a schede

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Identificatore per la scheda, nome del backlog del backlog della scheda (Eg:"Stories") o ID

Restituisce

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Ottenere colonne su una scheda

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Nome o ID della scheda specifica

Restituisce

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Restituisce l'elenco del modello di filtro del campo padre per l'elenco specificato di ID dell'elemento di lavoro

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

childBacklogContextCategoryRefName: string

workitemIds: number[]

Restituisce

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Ottenere righe su una scheda

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Nome o ID della scheda specifica

Restituisce

Promise<BoardRow[]>

getBoards(TeamContext)

Ottenere schede

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Ottenere le impostazioni utente della scheda per un ID scheda

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

board: string

ID o nome della scheda

Restituisce

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Ottenere la capacità di un team, inclusa la capacità totale e i giorni di disattivazione

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

Restituisce

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Ottenere la capacità di un membro del team

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

teamMemberId: string

ID del membro del team

Restituisce

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Ottenere le colonne della scheda disponibili in un progetto

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

Parametri

project: string

ID progetto o nome progetto

Restituisce

Promise<BoardSuggestedValue[]>

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

Ottenere i dati della visualizzazione recapito

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

Parametri

project: string

ID progetto o nome progetto

id: string

Identificatore per la visualizzazione recapito

revision: number

Revisione del piano per il quale si desiderano dati. Se il piano corrente è una revisione diversa, si otterrà un'eccezione ViewRevisionMismatchException. Se non si fornisce una revisione, si otterranno i dati per la revisione più recente.

startDate: Date

Data di inizio della sequenza temporale

endDate: Date

Data di fine della sequenza temporale

Restituisce

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Ottenere elementi di lavoro per l'iterazione

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

Restituisce

Promise<IterationWorkItems>

getPlan(string, string)

Ottenere le informazioni per il piano specificato

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

Parametri

project: string

ID progetto o nome progetto

id: string

Identificatore del piano

Restituisce

Promise<Plan>

getPlans(string)

Ottenere le informazioni per tutti i piani configurati per il team specificato

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

Parametri

project: string

ID progetto o nome progetto

Restituisce

Promise<Plan[]>

getProcessConfiguration(string)

Ottenere la configurazione del processo

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

Parametri

project: string

ID progetto o nome progetto

Restituisce

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Ottenere le righe della scheda disponibili in un progetto

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

Parametri

project: string

ID progetto o nome progetto

Restituisce

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Ottenere i giorni di attesa del team per un'iterazione

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

Restituisce

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Ottenere una raccolta di valori di campo del team

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Ottenere l'iterazione del team da iterazioneId

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

id: string

ID dell'iterazione

Restituisce

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Ottenere le iterazioni di un team usando il filtro dell'intervallo di tempo

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

timeframe: string

Filtro per cui vengono restituite iterazioni in base al tempo relativo. Attualmente è supportato solo Current.

Restituisce

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Ottenere le impostazioni di un team

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Ottenere la capacità di un'iterazione per tutti i team nell'iterazione

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

Parametri

project: string

ID progetto o nome progetto

iterationId: string

ID dell'iterazione

Restituisce

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

Restituisce

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Aggiungere un'iterazione al team

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

Parametri

iteration: TeamSettingsIteration

Iterazione da aggiungere

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Riordinare gli elementi di lavoro del prodotto/Schede

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

Parametri

operation: ReorderOperation

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Riordinare gli elementi di lavoro di Sprint Backlog/Taskboard

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

Parametri

operation: ReorderOperation

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

Restituisce

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Sostituire la capacità di un team

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

Parametri

capacities: TeamMemberCapacityIdentityRef[]

Capacità del team di sostituire

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

Restituisce

Promise<TeamMemberCapacityIdentityRef[]>

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

Opzioni della scheda di aggiornamento

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

Parametri

options: {[key: string]: string}

opzioni da aggiornare

teamContext: TeamContext

Contesto del team per l'operazione

id: string

identificatore per la scheda, nome plurale categoria (Eg:"Stories") o guid

Restituisce

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Crea/aggiorna le impostazioni delle regole di automazione

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

Parametri

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Parametri obbligatori per creare/aggiornare le impostazioni delle regole di automazione

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Aggiornare le impostazioni delle regole della scheda scheda per l'ID della scheda o della scheda in base al nome

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

Parametri

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Restituisce

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Aggiornare le impostazioni della scheda scheda per l'ID della scheda o della scheda in base al nome

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

Parametri

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Restituisce

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Aggiornare un grafico a scheda

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

Parametri

chart: BoardChart

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Identificatore per la scheda, nome del backlog del backlog della scheda (Eg:"Stories") o ID

name: string

Nome del grafico

Restituisce

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Aggiornare le colonne in una scheda

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

Parametri

boardColumns: BoardColumn[]

Elenco delle colonne della scheda da aggiornare

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Nome o ID della scheda specifica

Restituisce

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Aggiornare le righe in una scheda

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

Parametri

boardRows: BoardRow[]

Elenco delle righe della scheda da aggiornare

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Nome o ID della scheda specifica

Restituisce

Promise<BoardRow[]>

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

Aggiornare le impostazioni utente della scheda per l'ID scheda

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

Parametri

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Contesto del team per l'operazione

board: string

Restituisce

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Aggiornare la capacità di un membro del team

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

Parametri

patch: CapacityPatch

Capacità aggiornata

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

teamMemberId: string

ID del membro del team

Restituisce

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parametri

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Aggiornare le informazioni per il piano specificato

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

Parametri

updatedPlan: UpdatePlan

Definizione di piano da aggiornare

project: string

ID progetto o nome progetto

id: string

Identificatore del piano

Restituisce

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Aggiornare le impostazioni delle regole della scheda taskboard

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

Parametri

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Aggiornare le impostazioni della scheda di taskboard

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

Parametri

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Impostare i giorni di attesa di un team per un'iterazione

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

Parametri

daysOffPatch: TeamSettingsDaysOffPatch

I giorni di chiusura della patch del team che contengono un elenco di date di inizio e fine

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

ID dell'iterazione

Restituisce

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Aggiornare i valori dei campi del team

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

Parametri

patch: TeamFieldValuesPatch

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Aggiornare le impostazioni di un team

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

Parametri

teamSettingsPatch: TeamSettingsPatch

Modifiche di TeamSettings

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parametri

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Contesto del team per l'operazione

iterationId: string

workItemId: number

Restituisce

Promise<void>

Condividi tramite

WorkRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

WorkRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

createPlan(CreatePlan, string)

Parametri

Restituisce

deletePlan(string, string)

Parametri

Restituisce

deleteTeamIteration(TeamContext, string)

Parametri

Restituisce

getBacklog(TeamContext, string)

Parametri

Restituisce

getBacklogConfigurations(TeamContext)

Parametri

Restituisce

getBacklogLevelWorkItems(TeamContext, string)

Parametri

Restituisce

getBacklogs(TeamContext)

Parametri

Restituisce

getBoard(TeamContext, string)

Parametri

Restituisce

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

Parametri

Restituisce

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

Parametri

Restituisce

getBoardCardRuleSettings(TeamContext, string)

Parametri

Restituisce

getBoardCardSettings(TeamContext, string)

Parametri

Restituisce

getBoardChart(TeamContext, string, string)

Parametri

Restituisce

getBoardCharts(TeamContext, string)

Parametri

Restituisce

getBoardColumns(TeamContext, string)

Parametri

Restituisce

getBoardMappingParentItems(TeamContext, string, number[])

Parametri

Restituisce

getBoardRows(TeamContext, string)

Parametri

Restituisce

getBoards(TeamContext)

Parametri

Restituisce

getBoardUserSettings(TeamContext, string)

Parametri

Restituisce

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parametri

Restituisce

getCapacityWithIdentityRef(TeamContext, string, string)

Parametri

Restituisce

getColumns(TeamContext)

Parametri

Restituisce

getColumnSuggestedValues(string)

Parametri