WorkRestClient class

Odwołanie

Pakiet:: azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends: RestClientBase

Konstruktory

WorkRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createPlan(CreatePlan, string)	Dodawanie nowego planu dla zespołu
deletePlan(string, string)	Usuwanie określonego planu
deleteTeamIteration(TeamContext, string)	Usuwanie iteracji zespołu według iteracjiId
getBacklog(TeamContext, string)	Pobieranie poziomu listy prac
getBacklogConfigurations(TeamContext)	Pobiera konfigurację listy prac dla zespołu
getBacklogLevelWorkItems(TeamContext, string)	Pobieranie listy elementów roboczych na poziomie listy prac
getBacklogs(TeamContext)	Wyświetlanie listy wszystkich poziomów listy prac
getBoard(TeamContext, string)	Pobierz tablicę
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Pobiera wskaźnik, który wyświetla stan kolumn na tablicy.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Pobiera wskaźnik, który wyświetla stan kolumn na tablicy.
getBoardCardRuleSettings(TeamContext, string)	Pobierz ustawienia reguły karty tablicy dla identyfikatora tablicy lub tablicy według nazwy
getBoardCardSettings(TeamContext, string)	Pobierz ustawienia karty tablicy dla identyfikatora tablicy lub tablicy według nazwy
getBoardChart(TeamContext, string, string)	Pobieranie wykresu tablicowego
getBoardCharts(TeamContext, string)	Pobieranie wykresów tablicowych
getBoardColumns(TeamContext, string)	Pobieranie kolumn na tablicy
getBoardMappingParentItems(TeamContext, string, number[])	Zwraca listę modelu filtru pól nadrzędnych dla danej listy identyfikatorów elementu roboczego
getBoardRows(TeamContext, string)	Pobieranie wierszy na tablicy
getBoards(TeamContext)	Pobieranie płyt
getBoardUserSettings(TeamContext, string)	Pobieranie ustawień użytkownika tablicy dla identyfikatora tablicy
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Pobieranie pojemności zespołu, w tym całkowitej pojemności i dni wolnych
getCapacityWithIdentityRef(TeamContext, string, string)	Uzyskiwanie pojemności członka zespołu
getColumns(TeamContext)
getColumnSuggestedValues(string)	Pobieranie dostępnych kolumn tablicy w projekcie
getDeliveryTimelineData(string, string, number, Date, Date)	Pobieranie danych widoku dostarczania
getIterationWorkItems(TeamContext, string)	Pobieranie elementów roboczych na potrzeby iteracji
getPlan(string, string)	Pobieranie informacji dotyczących określonego planu
getPlans(string)	Pobieranie informacji dotyczących wszystkich planów skonfigurowanych dla danego zespołu
getProcessConfiguration(string)	Pobieranie konfiguracji procesu
getRowSuggestedValues(string)	Pobieranie dostępnych wierszy tablicy w projekcie
getTeamDaysOff(TeamContext, string)	Pobieranie dni wolnych od zespołu na iterację
getTeamFieldValues(TeamContext)	Pobieranie kolekcji wartości pól zespołu
getTeamIteration(TeamContext, string)	Pobieranie iteracji zespołu według iteracjiId
getTeamIterations(TeamContext, string)	Pobieranie iteracji zespołu przy użyciu filtru przedziału czasowego
getTeamSettings(TeamContext)	Pobieranie ustawień zespołu
getTotalIterationCapacities(string, string)	Uzyskiwanie pojemności iteracji dla wszystkich zespołów w iteracji
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Dodawanie iteracji do zespołu
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Zmień kolejność elementów roboczych listy prac/tablic produktów
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Zmiana kolejności listy prac przebiegu/elementów roboczych tablicy zadań
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Zastępowanie pojemności zespołu
setBoardOptions({[key: string]: string}, TeamContext, string)	Opcje tablicy aktualizacji
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Tworzy/aktualizuje ustawienia reguł automatyzacji
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Aktualizowanie ustawień reguły karty tablicy dla identyfikatora tablicy lub tablicy według nazwy
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Aktualizowanie ustawień karty tablicy dla identyfikatora tablicy lub tablicy według nazwy
updateBoardChart(BoardChart, TeamContext, string, string)	Aktualizowanie wykresu tablicowego
updateBoardColumns(BoardColumn[], TeamContext, string)	Aktualizowanie kolumn na tablicy
updateBoardRows(BoardRow[], TeamContext, string)	Aktualizowanie wierszy na tablicy
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Aktualizowanie ustawień użytkownika tablicy dla identyfikatora tablicy
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Aktualizowanie pojemności członka zespołu
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Aktualizowanie informacji dotyczących określonego planu
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Aktualizowanie ustawień reguły karty tablicy zadań
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Aktualizowanie ustawień karty tablicy zadań
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Ustawianie dni wolnych od zespołu na potrzeby iteracji
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Aktualizowanie wartości pól zespołu
updateTeamSettings(TeamSettingsPatch, TeamContext)	Aktualizowanie ustawień zespołu
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Szczegóły konstruktora

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

createPlan(CreatePlan, string)

Dodawanie nowego planu dla zespołu

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

Parametry

postedPlan: CreatePlan

Definicja planu

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Plan>

deletePlan(string, string)

Usuwanie określonego planu

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

id: string

Identyfikator planu

Zwraca

Promise<void>

deleteTeamIteration(TeamContext, string)

Usuwanie iteracji zespołu według iteracjiId

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

Identyfikator iteracji

Zwraca

Promise<void>

getBacklog(TeamContext, string)

Pobieranie poziomu listy prac

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

Identyfikator poziomu listy prac

Zwraca

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Pobiera konfigurację listy prac dla zespołu

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Pobieranie listy elementów roboczych na poziomie listy prac

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

backlogId: string

Zwraca

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Wyświetlanie listy wszystkich poziomów listy prac

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Pobierz tablicę

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

identyfikator tablicy, nazwa poziomu listy prac tablicy (Np.:"Stories") lub identyfikator

Zwraca

Promise<Board>

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

Pobiera wskaźnik, który wyświetla stan kolumn na tablicy.

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

Identyfikator tablicy.

columnOptions: BoardBadgeColumnOptions

Określa, które kolumny mają być wyświetlane.

columns: string[]

Jeśli kolumnaOptions jest ustawiona na wartość niestandardową, określ listę nazw kolumn.

Zwraca

Promise<BoardBadge>

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

Pobiera wskaźnik, który wyświetla stan kolumn na tablicy.

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

Identyfikator tablicy.

columnOptions: BoardBadgeColumnOptions

Określa, które kolumny mają być wyświetlane.

columns: string[]

Jeśli kolumnaOptions jest ustawiona na wartość niestandardową, określ listę nazw kolumn.

Zwraca

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Pobierz ustawienia reguły karty tablicy dla identyfikatora tablicy lub tablicy według nazwy

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Zwraca

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Pobierz ustawienia karty tablicy dla identyfikatora tablicy lub tablicy według nazwy

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Zwraca

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Pobieranie wykresu tablicowego

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Identyfikator tablicy, nazwa poziomu listy prac tablicy (Np.:"Stories") lub identyfikator

name: string

Nazwa wykresu

Zwraca

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Pobieranie wykresów tablicowych

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Identyfikator tablicy, nazwa poziomu listy prac tablicy (Np.:"Stories") lub identyfikator

Zwraca

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Pobieranie kolumn na tablicy

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Nazwa lub identyfikator konkretnej tablicy

Zwraca

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Zwraca listę modelu filtru pól nadrzędnych dla danej listy identyfikatorów elementu roboczego

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

childBacklogContextCategoryRefName: string

workitemIds: number[]

Zwraca

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Pobieranie wierszy na tablicy

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Nazwa lub identyfikator konkretnej tablicy

Zwraca

Promise<BoardRow[]>

getBoards(TeamContext)

Pobieranie płyt

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Pobieranie ustawień użytkownika tablicy dla identyfikatora tablicy

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Identyfikator tablicy lub nazwa

Zwraca

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Pobieranie pojemności zespołu, w tym całkowitej pojemności i dni wolnych

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

Zwraca

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Uzyskiwanie pojemności członka zespołu

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

teamMemberId: string

Identyfikator członka zespołu

Zwraca

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Pobieranie dostępnych kolumn tablicy w projekcie

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BoardSuggestedValue[]>

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

Pobieranie danych widoku dostarczania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

id: string

Identyfikator widoku dostarczania

revision: number

Poprawka planu, dla którego mają być potrzebne dane. Jeśli bieżący plan jest inną wersją, otrzymasz wyjątek ViewRevisionMismatchException. Jeśli nie podasz poprawki, otrzymasz dane dotyczące najnowszej poprawki.

startDate: Date

Data rozpoczęcia osi czasu

endDate: Date

Data zakończenia osi czasu

Zwraca

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Pobieranie elementów roboczych na potrzeby iteracji

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

Zwraca

Promise<IterationWorkItems>

getPlan(string, string)

Pobieranie informacji dotyczących określonego planu

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

id: string

Identyfikator planu

Zwraca

Promise<Plan>

getPlans(string)

Pobieranie informacji dotyczących wszystkich planów skonfigurowanych dla danego zespołu

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Plan[]>

getProcessConfiguration(string)

Pobieranie konfiguracji procesu

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Pobieranie dostępnych wierszy tablicy w projekcie

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Pobieranie dni wolnych od zespołu na iterację

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

Zwraca

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Pobieranie kolekcji wartości pól zespołu

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Pobieranie iteracji zespołu według iteracjiId

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

Identyfikator iteracji

Zwraca

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Pobieranie iteracji zespołu przy użyciu filtru przedziału czasowego

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

timeframe: string

Filtr, dla którego są zwracane iteracji na podstawie czasu względnego. Obecnie jest obsługiwany tylko bieżący.

Zwraca

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Pobieranie ustawień zespołu

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Uzyskiwanie pojemności iteracji dla wszystkich zespołów w iteracji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

iterationId: string

Identyfikator iteracji

Zwraca

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parametry

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Zwraca

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Dodawanie iteracji do zespołu

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

Parametry

iteration: TeamSettingsIteration

Iteracja do dodania

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Zmień kolejność elementów roboczych listy prac/tablic produktów

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

Parametry

operation: ReorderOperation

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Zmiana kolejności listy prac przebiegu/elementów roboczych tablicy zadań

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

Parametry

operation: ReorderOperation

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

Zwraca

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Zastępowanie pojemności zespołu

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

Parametry

capacities: TeamMemberCapacityIdentityRef[]

Pojemność zespołu do zastąpienia

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

Zwraca

Promise<TeamMemberCapacityIdentityRef[]>

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

Opcje tablicy aktualizacji

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

Parametry

options: {[key: string]: string}

opcje aktualizacji

teamContext: TeamContext

Kontekst zespołu dla operacji

id: string

identyfikator tablicy, nazwa mnogiej kategorii (Np."Historie") lub identyfikator GUID

Zwraca

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Tworzy/aktualizuje ustawienia reguł automatyzacji

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

Parametry

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Wymagane parametry do utworzenia/zaktualizowania ustawień reguł automatyzacji

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Aktualizowanie ustawień reguły karty tablicy dla identyfikatora tablicy lub tablicy według nazwy

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

Parametry

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Zwraca

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Aktualizowanie ustawień karty tablicy dla identyfikatora tablicy lub tablicy według nazwy

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

Parametry

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Zwraca

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Aktualizowanie wykresu tablicowego

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

Parametry

chart: BoardChart

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Identyfikator tablicy, nazwa poziomu listy prac tablicy (np. "Historie") lub identyfikator

name: string

Nazwa wykresu

Zwraca

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Aktualizowanie kolumn na tablicy

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

Parametry

boardColumns: BoardColumn[]

Lista kolumn tablicy do zaktualizowania

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Nazwa lub identyfikator określonej tablicy

Zwraca

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Aktualizowanie wierszy na tablicy

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

Parametry

boardRows: BoardRow[]

Lista wierszy tablicy do zaktualizowania

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Nazwa lub identyfikator określonej tablicy

Zwraca

Promise<BoardRow[]>

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

Aktualizowanie ustawień użytkownika tablicy dla identyfikatora tablicy

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

Parametry

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Kontekst zespołu dla operacji

board: string

Zwraca

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Aktualizowanie pojemności członka zespołu

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

Parametry

patch: CapacityPatch

Zaktualizowana pojemność

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

teamMemberId: string

Identyfikator członka zespołu

Zwraca

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parametry

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Aktualizowanie informacji dotyczących określonego planu

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

Parametry

updatedPlan: UpdatePlan

Definicja planu, która ma zostać zaktualizowana

project: string

Identyfikator projektu lub nazwa projektu

id: string

Identyfikator planu

Zwraca

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Aktualizowanie ustawień reguły karty tablicy zadań

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

Parametry

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Aktualizowanie ustawień karty tablicy zadań

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

Parametry

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Ustawianie dni wolnych od zespołu na potrzeby iteracji

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

Parametry

daysOffPatch: TeamSettingsDaysOffPatch

Liczba dni wolnych od poprawki zespołu zawierająca listę dat rozpoczęcia i zakończenia

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

Identyfikator iteracji

Zwraca

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Aktualizowanie wartości pól zespołu

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

Parametry

patch: TeamFieldValuesPatch

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Aktualizowanie ustawień zespołu

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

Parametry

teamSettingsPatch: TeamSettingsPatch

Zmiany teamSettings

teamContext: TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parametry

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Kontekst zespołu dla operacji

iterationId: string

workItemId: number

Zwraca

Promise<void>

Udostępnij za pośrednictwem

WorkRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

WorkRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

createPlan(CreatePlan, string)

Parametry

Zwraca

deletePlan(string, string)

Parametry

Zwraca

deleteTeamIteration(TeamContext, string)

Parametry

Zwraca

getBacklog(TeamContext, string)

Parametry

Zwraca

getBacklogConfigurations(TeamContext)

Parametry

Zwraca

getBacklogLevelWorkItems(TeamContext, string)

Parametry

Zwraca

getBacklogs(TeamContext)

Parametry

Zwraca

getBoard(TeamContext, string)

Parametry

Zwraca

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

Parametry

Zwraca

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

Parametry

Zwraca

getBoardCardRuleSettings(TeamContext, string)

Parametry

Zwraca

getBoardCardSettings(TeamContext, string)

Parametry

Zwraca

getBoardChart(TeamContext, string, string)

Parametry

Zwraca

getBoardCharts(TeamContext, string)

Parametry

Zwraca

getBoardColumns(TeamContext, string)

Parametry

Zwraca

getBoardMappingParentItems(TeamContext, string, number[])

Parametry

Zwraca

getBoardRows(TeamContext, string)

Parametry

Zwraca

getBoards(TeamContext)

Parametry

Zwraca

getBoardUserSettings(TeamContext, string)

Parametry

Zwraca

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parametry

Zwraca

getCapacityWithIdentityRef(TeamContext, string, string)

Parametry

Zwraca

getColumns(TeamContext)

Parametry

Zwraca

getColumnSuggestedValues(string)

Parametry