WorkRestClient class
Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS
- Extends
| create |
Aggiungere un nuovo piano per il team |
| delete |
Eliminare il piano specificato |
| delete |
Eliminare l'iterazione di un team in base all'iterazioneId |
| get |
Ottenere un livello di backlog |
| get |
Ottiene la configurazione del backlog per un team |
| get |
Ottenere un elenco di elementi di lavoro all'interno di un livello backlog |
| get |
Elencare tutti i livelli di backlog |
| get |
Get board |
| get |
Ottiene un badge che visualizza lo stato delle colonne sulla scheda. |
| get |
Ottiene un badge che visualizza lo stato delle colonne sulla scheda. |
| get |
Ottenere le impostazioni delle regole della scheda scheda per l'ID scheda o la scheda in base al nome |
| get |
Ottenere le impostazioni della scheda scheda per l'ID della scheda o della scheda in base al nome |
| get |
Ottenere un grafico a bordo |
| get |
Ottenere grafici a schede |
| get |
Ottenere colonne su una scheda |
| get |
Restituisce l'elenco del modello di filtro del campo padre per l'elenco specificato di ID dell'elemento di lavoro |
| get |
Ottenere righe su una scheda |
| get |
Ottenere schede |
| get |
Ottenere le impostazioni utente della scheda per un ID scheda |
| get |
Ottenere la capacità di un team, inclusa la capacità totale e i giorni di disattivazione |
| get |
Ottenere la capacità di un membro del team |
| get |
|
| get |
Ottenere le colonne della scheda disponibili in un progetto |
| get |
Ottenere i dati della visualizzazione recapito |
| get |
Ottenere elementi di lavoro per l'iterazione |
| get |
Ottenere le informazioni per il piano specificato |
| get |
Ottenere le informazioni per tutti i piani configurati per il team specificato |
| get |
Ottenere la configurazione del processo |
| get |
Ottenere le righe della scheda disponibili in un progetto |
| get |
Ottenere i giorni di attesa del team per un'iterazione |
| get |
Ottenere una raccolta di valori di campo del team |
| get |
Ottenere l'iterazione del team da iterazioneId |
| get |
Ottenere le iterazioni di un team usando il filtro dell'intervallo di tempo |
| get |
Ottenere le impostazioni di un team |
| get |
Ottenere la capacità di un'iterazione per tutti i team nell'iterazione |
| get |
|
| post |
Aggiungere un'iterazione al team |
| reorder |
Riordinare gli elementi di lavoro del prodotto/Schede |
| reorder |
Riordinare gli elementi di lavoro di Sprint Backlog/Taskboard |
| replace |
Sostituire la capacità di un team |
| set |
Opzioni della scheda di aggiornamento |
| update |
Crea/aggiorna le impostazioni delle regole di automazione |
| update |
Aggiornare le impostazioni delle regole della scheda scheda per l'ID della scheda o della scheda in base al nome |
| update |
Aggiornare le impostazioni della scheda scheda per l'ID della scheda o della scheda in base al nome |
| update |
Aggiornare un grafico a scheda |
| update |
Aggiornare le colonne in una scheda |
| update |
Aggiornare le righe in una scheda |
| update |
Aggiornare le impostazioni utente della scheda per l'ID scheda |
| update |
Aggiornare la capacità di un membro del team |
| update |
|
| update |
Aggiornare le informazioni per il piano specificato |
| update |
Aggiornare le impostazioni delle regole della scheda taskboard |
| update |
Aggiornare le impostazioni della scheda di taskboard |
| update |
Impostare i giorni di attesa di un team per un'iterazione |
| update |
Aggiornare i valori dei campi del team |
| update |
Aggiornare le impostazioni di un team |
| update |
static RESOURCE_AREA_ID: stringValore della proprietà
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>
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>
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>
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>
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>
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>
Elencare tutti i livelli di backlog
function getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<BacklogLevelConfiguration[]>
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>
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>
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>
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>
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>
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>
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[]>
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[]>
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[]>
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[]>
Ottenere schede
function getBoards(teamContext: TeamContext): Promise<BoardReference[]>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<BoardReference[]>
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>
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>
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>
function getColumns(teamContext: TeamContext): Promise<TaskboardColumns>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<TaskboardColumns>
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[]>
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>
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>
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>
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[]>
Ottenere la configurazione del processo
function getProcessConfiguration(project: string): Promise<ProcessConfiguration>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<ProcessConfiguration>
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[]>
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>
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>
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>
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[]>
Ottenere le impostazioni di un team
function getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<TeamSetting>
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>
function getWorkItemColumns(teamContext: TeamContext, iterationId: string): Promise<TaskboardWorkItemColumn[]>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
- iterationId
-
string
Restituisce
Promise<TaskboardWorkItemColumn[]>
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>
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[]>
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[]>
Sostituire la capacità di un team
function replaceCapacitiesWithIdentityRef(capacities: TeamMemberCapacityIdentityRef[], teamContext: TeamContext, iterationId: string): Promise<TeamMemberCapacityIdentityRef[]>Parametri
- capacities
Capacità del team di sostituire
- teamContext
- TeamContext
Contesto del team per l'operazione
- iterationId
-
string
ID dell'iterazione
Restituisce
Promise<TeamMemberCapacityIdentityRef[]>
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}>
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>
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>
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>
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>
Aggiornare le colonne in una scheda
function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>Parametri
- boardColumns
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[]>
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[]>
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>
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>
function updateColumns(updateColumns: UpdateTaskboardColumn[], teamContext: TeamContext): Promise<TaskboardColumns>Parametri
- updateColumns
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<TaskboardColumns>
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>
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>
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>
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>
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>
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>
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>