WorkRestClient class
Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS
- Extends
Konstruktory
Work |
Vlastnosti
RESOURCE_AREA_ID |
Metody
Podrobnosti konstruktoru
WorkRestClient(IVssRestClientOptions)
Podrobnosti vlastnosti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
Hodnota vlastnosti
string
Podrobnosti metody
createPlan(CreatePlan, string)
Přidání nového plánu pro tým
function createPlan(postedPlan: CreatePlan, project: string): Promise<Plan>
Parametry
- postedPlan
- CreatePlan
Definice plánu
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<Plan>
deletePlan(string, string)
Odstranění zadaného plánu
function deletePlan(project: string, id: string): Promise<void>
Parametry
- project
-
string
ID projektu nebo název projektu
- id
-
string
Identifikátor plánu
Návraty
Promise<void>
deleteTeamIteration(TeamContext, string)
Odstranění iterace týmu pomocí iterationId
function deleteTeamIteration(teamContext: TeamContext, id: string): Promise<void>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
ID iterace
Návraty
Promise<void>
getBacklog(TeamContext, string)
Získání úrovně backlogu
function getBacklog(teamContext: TeamContext, id: string): Promise<BacklogLevelConfiguration>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
ID úrovně backlogu
Návraty
Promise<BacklogLevelConfiguration>
getBacklogConfigurations(TeamContext)
Získá konfiguraci backlogu pro tým
function getBacklogConfigurations(teamContext: TeamContext): Promise<BacklogConfiguration>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<BacklogConfiguration>
getBacklogLevelWorkItems(TeamContext, string)
Získání seznamu pracovních položek na úrovni backlogu
function getBacklogLevelWorkItems(teamContext: TeamContext, backlogId: string): Promise<BacklogLevelWorkItems>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- backlogId
-
string
Návraty
Promise<BacklogLevelWorkItems>
getBacklogs(TeamContext)
Vypsat všechny úrovně backlogu
function getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<BacklogLevelConfiguration[]>
getBoard(TeamContext, string)
Získat tabuli
function getBoard(teamContext: TeamContext, id: string): Promise<Board>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
identifikátor panelu, název úrovně backlogu panelu (např.:"Scénáře") nebo ID
Návraty
Promise<Board>
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])
Získá odznáček, který zobrazuje stav sloupců na panelu.
function getBoardBadge(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<BoardBadge>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
ID tabule.
- columnOptions
- BoardBadgeColumnOptions
Určuje, které sloupce se mají zobrazit.
- columns
-
string[]
Pokud je možnost columnOptions nastavená na vlastní, zadejte seznam názvů sloupců.
Návraty
Promise<BoardBadge>
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])
Získá odznáček, který zobrazuje stav sloupců na panelu.
function getBoardBadgeData(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<string>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
ID tabule.
- columnOptions
- BoardBadgeColumnOptions
Určuje, které sloupce se mají zobrazit.
- columns
-
string[]
Pokud je možnost columnOptions nastavená na vlastní, zadejte seznam názvů sloupců.
Návraty
Promise<string>
getBoardCardRuleSettings(TeamContext, string)
Získání nastavení pravidla karty desky pro ID panelu nebo panelu podle názvu
function getBoardCardRuleSettings(teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Návraty
Promise<BoardCardRuleSettings>
getBoardCardSettings(TeamContext, string)
Získání nastavení karty desky pro ID panelu nebo panelu podle názvu
function getBoardCardSettings(teamContext: TeamContext, board: string): Promise<BoardCardSettings>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Návraty
Promise<BoardCardSettings>
getBoardChart(TeamContext, string, string)
Získání tabulového grafu
function getBoardChart(teamContext: TeamContext, board: string, name: string): Promise<BoardChart>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Identifikátor panelu, název úrovně backlogu panelu (např.:"Scénáře") nebo ID
- name
-
string
Název grafu
Návraty
Promise<BoardChart>
getBoardCharts(TeamContext, string)
Získání tabulových grafů
function getBoardCharts(teamContext: TeamContext, board: string): Promise<BoardChartReference[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Identifikátor panelu, název úrovně backlogu panelu (např.:"Scénáře") nebo ID
Návraty
Promise<BoardChartReference[]>
getBoardColumns(TeamContext, string)
Získání sloupců na panelu
function getBoardColumns(teamContext: TeamContext, board: string): Promise<BoardColumn[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Název nebo ID konkrétního panelu
Návraty
Promise<BoardColumn[]>
getBoardMappingParentItems(TeamContext, string, number[])
Vrátí seznam modelu filtru nadřazených polí pro daný seznam ID pracovní položky.
function getBoardMappingParentItems(teamContext: TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<ParentChildWIMap[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- childBacklogContextCategoryRefName
-
string
- workitemIds
-
number[]
Návraty
Promise<ParentChildWIMap[]>
getBoardRows(TeamContext, string)
Získání řádků na panelu
function getBoardRows(teamContext: TeamContext, board: string): Promise<BoardRow[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Název nebo ID konkrétního panelu
Návraty
Promise<BoardRow[]>
getBoards(TeamContext)
Získání panelů
function getBoards(teamContext: TeamContext): Promise<BoardReference[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<BoardReference[]>
getBoardUserSettings(TeamContext, string)
Získání uživatelského nastavení panelu pro ID panelu
function getBoardUserSettings(teamContext: TeamContext, board: string): Promise<BoardUserSettings>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
ID nebo název panelu
Návraty
Promise<BoardUserSettings>
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)
Získání kapacity týmu včetně celkové kapacity a dnů volna
function getCapacitiesWithIdentityRefAndTotals(teamContext: TeamContext, iterationId: string): Promise<TeamCapacity>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
Návraty
Promise<TeamCapacity>
getCapacityWithIdentityRef(TeamContext, string, string)
Získání kapacity člena týmu
function getCapacityWithIdentityRef(teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
- teamMemberId
-
string
ID člena týmu
Návraty
Promise<TeamMemberCapacityIdentityRef>
getColumns(TeamContext)
function getColumns(teamContext: TeamContext): Promise<TaskboardColumns>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TaskboardColumns>
getColumnSuggestedValues(string)
Získání dostupných sloupců panelu v projektu
function getColumnSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>
Parametry
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<BoardSuggestedValue[]>
getDeliveryTimelineData(string, string, number, Date, Date)
Získání dat zobrazení doručení
function getDeliveryTimelineData(project: string, id: string, revision?: number, startDate?: Date, endDate?: Date): Promise<DeliveryViewData>
Parametry
- project
-
string
ID projektu nebo název projektu
- id
-
string
Identifikátor zobrazení doručení
- revision
-
number
Revize plánu, pro který chcete data Pokud je aktuální plán jinou revizí, zobrazí se výjimka ViewRevisionMismatchException. Pokud revizi nezadáte, získáte data pro nejnovější revizi.
- startDate
-
Date
Počáteční datum časové osy
- endDate
-
Date
Koncové datum časové osy
Návraty
Promise<DeliveryViewData>
getIterationWorkItems(TeamContext, string)
Získání pracovních položek pro iteraci
function getIterationWorkItems(teamContext: TeamContext, iterationId: string): Promise<IterationWorkItems>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
Návraty
Promise<IterationWorkItems>
getPlan(string, string)
Získání informací o zadaném plánu
function getPlan(project: string, id: string): Promise<Plan>
Parametry
- project
-
string
ID projektu nebo název projektu
- id
-
string
Identifikátor plánu
Návraty
Promise<Plan>
getPlans(string)
Získání informací o všech plánech nakonfigurovaných pro daný tým
function getPlans(project: string): Promise<Plan[]>
Parametry
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<Plan[]>
getProcessConfiguration(string)
Získání konfigurace procesu
function getProcessConfiguration(project: string): Promise<ProcessConfiguration>
Parametry
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<ProcessConfiguration>
getRowSuggestedValues(string)
Získání dostupných řádků panelu v projektu
function getRowSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>
Parametry
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<BoardSuggestedValue[]>
getTeamDaysOff(TeamContext, string)
Získejte dny volna týmu na iteraci
function getTeamDaysOff(teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
Návraty
Promise<TeamSettingsDaysOff>
getTeamFieldValues(TeamContext)
Získání kolekce hodnot pole týmu
function getTeamFieldValues(teamContext: TeamContext): Promise<TeamFieldValues>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TeamFieldValues>
getTeamIteration(TeamContext, string)
Získání iterace týmu pomocí iterationId
function getTeamIteration(teamContext: TeamContext, id: string): Promise<TeamSettingsIteration>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
ID iterace
Návraty
Promise<TeamSettingsIteration>
getTeamIterations(TeamContext, string)
Získání iterací týmu pomocí filtru časového rámce
function getTeamIterations(teamContext: TeamContext, timeframe?: string): Promise<TeamSettingsIteration[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- timeframe
-
string
Filtr, pro který jsou iterace vráceny na základě relativního času. V současné době se podporuje pouze aktuální.
Návraty
Promise<TeamSettingsIteration[]>
getTeamSettings(TeamContext)
Získání nastavení týmu
function getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TeamSetting>
getTotalIterationCapacities(string, string)
Získání kapacity iterace pro všechny týmy v iteraci
function getTotalIterationCapacities(project: string, iterationId: string): Promise<IterationCapacity>
Parametry
- project
-
string
ID projektu nebo název projektu
- iterationId
-
string
ID iterace
Návraty
Promise<IterationCapacity>
getWorkItemColumns(TeamContext, string)
function getWorkItemColumns(teamContext: TeamContext, iterationId: string): Promise<TaskboardWorkItemColumn[]>
Parametry
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
Návraty
Promise<TaskboardWorkItemColumn[]>
postTeamIteration(TeamSettingsIteration, TeamContext)
Přidání iterace do týmu
function postTeamIteration(iteration: TeamSettingsIteration, teamContext: TeamContext): Promise<TeamSettingsIteration>
Parametry
- iteration
- TeamSettingsIteration
Přidání iterace
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TeamSettingsIteration>
reorderBacklogWorkItems(ReorderOperation, TeamContext)
Změna pořadí produktových backlogů nebo pracovních položek na panelech
function reorderBacklogWorkItems(operation: ReorderOperation, teamContext: TeamContext): Promise<ReorderResult[]>
Parametry
- operation
- ReorderOperation
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<ReorderResult[]>
reorderIterationWorkItems(ReorderOperation, TeamContext, string)
Změna pořadí backlogu sprintu nebo pracovních položek na taskboardu
function reorderIterationWorkItems(operation: ReorderOperation, teamContext: TeamContext, iterationId: string): Promise<ReorderResult[]>
Parametry
- operation
- ReorderOperation
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
Návraty
Promise<ReorderResult[]>
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)
Nahrazení kapacity týmu
function replaceCapacitiesWithIdentityRef(capacities: TeamMemberCapacityIdentityRef[], teamContext: TeamContext, iterationId: string): Promise<TeamMemberCapacityIdentityRef[]>
Parametry
- capacities
Kapacita týmu k nahrazení
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
Návraty
Promise<TeamMemberCapacityIdentityRef[]>
setBoardOptions({[key: string]: string}, TeamContext, string)
Možnosti aktualizačního panelu
function setBoardOptions(options: {[key: string]: string}, teamContext: TeamContext, id: string): Promise<{[key: string]: string}>
Parametry
- options
-
{[key: string]: string}
možnosti aktualizace
- teamContext
- TeamContext
Kontext týmu pro operaci
- id
-
string
identifikátor pro panel, buď název kategorie v množném čísle (např.:"Stories") nebo guid
Návraty
Promise<{[key: string]: string}>
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)
Vytvoří nebo aktualizuje nastavení pravidel automatizace.
function updateAutomationRule(ruleRequestModel: TeamAutomationRulesSettingsRequestModel, teamContext: TeamContext): Promise<void>
Parametry
- ruleRequestModel
- TeamAutomationRulesSettingsRequestModel
Požadované parametry pro vytvoření nebo aktualizaci nastavení pravidel automatizace
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<void>
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)
Update board card Rule settings for the board ID or board by name
function updateBoardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>
Parametry
- boardCardRuleSettings
- BoardCardRuleSettings
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Návraty
Promise<BoardCardRuleSettings>
updateBoardCardSettings(BoardCardSettings, TeamContext, string)
Aktualizace nastavení karty panelu pro ID panelu nebo panelu podle názvu
function updateBoardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext, board: string): Promise<BoardCardSettings>
Parametry
- boardCardSettingsToSave
- BoardCardSettings
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Návraty
Promise<BoardCardSettings>
updateBoardChart(BoardChart, TeamContext, string, string)
Aktualizace tabulového grafu
function updateBoardChart(chart: BoardChart, teamContext: TeamContext, board: string, name: string): Promise<BoardChart>
Parametry
- chart
- BoardChart
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Identifikátor desky, název úrovně backlogu desky (např.:"Stories") nebo ID
- name
-
string
Název grafu
Návraty
Promise<BoardChart>
updateBoardColumns(BoardColumn[], TeamContext, string)
Aktualizace sloupců na panelu
function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>
Parametry
- boardColumns
Seznam sloupců panelu, které se mají aktualizovat
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Název nebo ID konkrétního panelu
Návraty
Promise<BoardColumn[]>
updateBoardRows(BoardRow[], TeamContext, string)
Aktualizace řádků na panelu
function updateBoardRows(boardRows: BoardRow[], teamContext: TeamContext, board: string): Promise<BoardRow[]>
Parametry
- boardRows
-
BoardRow[]
Seznam řádků panelu, které se mají aktualizovat
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Název nebo ID konkrétního panelu
Návraty
Promise<BoardRow[]>
updateBoardUserSettings({[key: string]: string}, TeamContext, string)
Aktualizační uživatelské nastavení pro ID panelu
function updateBoardUserSettings(boardUserSettings: {[key: string]: string}, teamContext: TeamContext, board: string): Promise<BoardUserSettings>
Parametry
- boardUserSettings
-
{[key: string]: string}
- teamContext
- TeamContext
Kontext týmu pro operaci
- board
-
string
Návraty
Promise<BoardUserSettings>
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)
Aktualizace kapacity člena týmu
function updateCapacityWithIdentityRef(patch: CapacityPatch, teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>
Parametry
- patch
- CapacityPatch
Aktualizovaná kapacita
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
- teamMemberId
-
string
ID člena týmu
Návraty
Promise<TeamMemberCapacityIdentityRef>
updateColumns(UpdateTaskboardColumn[], TeamContext)
function updateColumns(updateColumns: UpdateTaskboardColumn[], teamContext: TeamContext): Promise<TaskboardColumns>
Parametry
- updateColumns
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TaskboardColumns>
updatePlan(UpdatePlan, string, string)
Aktualizace informací pro zadaný plán
function updatePlan(updatedPlan: UpdatePlan, project: string, id: string): Promise<Plan>
Parametry
- updatedPlan
- UpdatePlan
Definice plánu, která se má aktualizovat
- project
-
string
ID projektu nebo název projektu
- id
-
string
Identifikátor plánu
Návraty
Promise<Plan>
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)
Aktualizace nastavení pravidla karty taskboard
function updateTaskboardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext): Promise<void>
Parametry
- boardCardRuleSettings
- BoardCardRuleSettings
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<void>
updateTaskboardCardSettings(BoardCardSettings, TeamContext)
Aktualizace nastavení karty taskboardu
function updateTaskboardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext): Promise<void>
Parametry
- boardCardSettingsToSave
- BoardCardSettings
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<void>
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)
Nastavení dnů volna týmu na iteraci
function updateTeamDaysOff(daysOffPatch: TeamSettingsDaysOffPatch, teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>
Parametry
- daysOffPatch
- TeamSettingsDaysOffPatch
Oprava dnů volna týmu obsahující seznam počátečních a koncových dat
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
ID iterace
Návraty
Promise<TeamSettingsDaysOff>
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)
Aktualizace hodnot týmových polí
function updateTeamFieldValues(patch: TeamFieldValuesPatch, teamContext: TeamContext): Promise<TeamFieldValues>
Parametry
- patch
- TeamFieldValuesPatch
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TeamFieldValues>
updateTeamSettings(TeamSettingsPatch, TeamContext)
Aktualizace nastavení týmu
function updateTeamSettings(teamSettingsPatch: TeamSettingsPatch, teamContext: TeamContext): Promise<TeamSetting>
Parametry
- teamSettingsPatch
- TeamSettingsPatch
Změny TeamSettings
- teamContext
- TeamContext
Kontext týmu pro operaci
Návraty
Promise<TeamSetting>
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)
function updateWorkItemColumn(updateColumn: UpdateTaskboardWorkItemColumn, teamContext: TeamContext, iterationId: string, workItemId: number): Promise<void>
Parametry
- updateColumn
- UpdateTaskboardWorkItemColumn
- teamContext
- TeamContext
Kontext týmu pro operaci
- iterationId
-
string
- workItemId
-
number
Návraty
Promise<void>