WorkRestClient class

Referenz

Paket:: azure-devops-extension-api

Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).

Extends: RestClientBase

Konstruktoren

WorkRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

createPlan(CreatePlan, string)	Hinzufügen eines neuen Plans für das Team
deletePlan(string, string)	Löschen des angegebenen Plans
deleteTeamIteration(TeamContext, string)	Löschen der Iteration eines Teams nach iterationId
getBacklog(TeamContext, string)	Abrufen einer Backlogebene
getBacklogConfigurations(TeamContext)	Ruft die Backlogkonfiguration für ein Team ab.
getBacklogLevelWorkItems(TeamContext, string)	Abrufen einer Liste von Arbeitselementen innerhalb einer Backlogebene
getBacklogs(TeamContext)	Auflisten aller Backlogebenen
getBoard(TeamContext, string)	Board abrufen
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Ruft einen Badge ab, der die status der Spalten auf dem Board anzeigt.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Ruft einen Badge ab, der die status der Spalten auf dem Board anzeigt.
getBoardCardRuleSettings(TeamContext, string)	Abrufen von Board- Karte Regeleinstellungen für die Board-ID oder das Board nach Name
getBoardCardSettings(TeamContext, string)	Abrufen von Board-Karte-Einstellungen für die Board-ID oder das Board anhand des Namens
getBoardChart(TeamContext, string, string)	Abrufen eines Boarddiagramms
getBoardCharts(TeamContext, string)	Abrufen von Boarddiagrammen
getBoardColumns(TeamContext, string)	Abrufen von Spalten auf einem Board
getBoardMappingParentItems(TeamContext, string, number[])	Gibt die Liste des Filtermodells des übergeordneten Felds für die angegebene Liste der Arbeitselement-IDs zurück.
getBoardRows(TeamContext, string)	Abrufen von Zeilen auf einem Board
getBoards(TeamContext)	Abrufen von Boards
getBoardUserSettings(TeamContext, string)	Abrufen von Boardbenutzereinstellungen für eine Board-ID
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Abrufen der Kapazität eines Teams einschließlich Gesamtkapazität und freien Tagen
getCapacityWithIdentityRef(TeamContext, string, string)	Abrufen der Kapazität eines Teammitglieds
getColumns(TeamContext)
getColumnSuggestedValues(string)	Abrufen verfügbarer Boardspalten in einem Projekt
getDeliveryTimelineData(string, string, number, Date, Date)	Abrufen von Übermittlungsansichtsdaten
getIterationWorkItems(TeamContext, string)	Abrufen von Arbeitselementen für die Iteration
getPlan(string, string)	Abrufen der Informationen für den angegebenen Plan
getPlans(string)	Abrufen der Informationen für alle Pläne, die für das angegebene Team konfiguriert sind
getProcessConfiguration(string)	Abrufen der Prozesskonfiguration
getRowSuggestedValues(string)	Abrufen verfügbarer Boardzeilen in einem Projekt
getTeamDaysOff(TeamContext, string)	Abrufen der freien Tage des Teams für eine Iteration
getTeamFieldValues(TeamContext)	Abrufen einer Sammlung von Teamfeldwerten
getTeamIteration(TeamContext, string)	Abrufen der Iteration des Teams nach IterationId
getTeamIterations(TeamContext, string)	Abrufen der Iterationen eines Teams mithilfe des Zeitrahmenfilters
getTeamSettings(TeamContext)	Abrufen der Einstellungen eines Teams
getTotalIterationCapacities(string, string)	Abrufen der Kapazität einer Iteration für alle Teams in der Iteration
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Hinzufügen einer Iteration zum Team
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Neuanordnen von Arbeitselementen für Produktbacklog/Boards
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Neuanordnen von Sprint Backlog/Taskboard-Arbeitselementen
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Ersetzen der Kapazität eines Teams
setBoardOptions({[key: string]: string}, TeamContext, string)	Boardoptionen aktualisieren
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Erstellt/aktualisiert Einstellungen für Automatisierungsregeln
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Aktualisieren der Board-Karte Regeleinstellungen für die Board-ID oder das Board nach Name
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Aktualisieren der Board-Karte Einstellungen für die Board-ID oder das Board nach Name
updateBoardChart(BoardChart, TeamContext, string, string)	Aktualisieren eines Kartendiagramms
updateBoardColumns(BoardColumn[], TeamContext, string)	Aktualisieren von Spalten auf einem Board
updateBoardRows(BoardRow[], TeamContext, string)	Aktualisieren von Zeilen auf einer Platine
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Aktualisieren der Boardbenutzereinstellungen für die Board-ID
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Aktualisieren der Kapazität eines Teammitglieds
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Aktualisieren der Informationen für den angegebenen Plan
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Aktualisieren von Taskboard- Karte Regeleinstellungen
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Taskboard-Karte-Einstellungen aktualisieren
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Festlegen der freien Tage eines Teams für eine Iteration
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Aktualisieren von Teamfeldwerten
updateTeamSettings(TeamSettingsPatch, TeamContext)	Aktualisieren der Einstellungen eines Teams
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Details zum Konstruktor

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

createPlan(CreatePlan, string)

Hinzufügen eines neuen Plans für das Team

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

Parameter

postedPlan: CreatePlan

Plandefinition

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Plan>

deletePlan(string, string)

Löschen des angegebenen Plans

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

Parameter

project: string

Projekt-ID oder Projektname

id: string

Bezeichner des Plans

Gibt zurück

Promise<void>

deleteTeamIteration(TeamContext, string)

Löschen der Iteration eines Teams nach iterationId

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

ID der Iteration

Gibt zurück

Promise<void>

getBacklog(TeamContext, string)

Abrufen einer Backlogebene

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

Die ID der Backlogebene

Gibt zurück

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Ruft die Backlogkonfiguration für ein Team ab.

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Abrufen einer Liste von Arbeitselementen innerhalb einer Backlogebene

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

backlogId: string

Gibt zurück

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Auflisten aller Backlogebenen

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Board abrufen

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

Bezeichner für das Board, entweder Name der Backlogebene des Boards (z. B. "Stories") oder ID

Gibt zurück

Promise<Board>

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

Ruft einen Badge ab, der die status der Spalten auf dem Board anzeigt.

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

Die ID des Boards.

columnOptions: BoardBadgeColumnOptions

Bestimmt, welche Spalten angezeigt werden sollen.

columns: string[]

Wenn columnOptions auf benutzerdefiniert festgelegt ist, geben Sie die Liste der Spaltennamen an.

Gibt zurück

Promise<BoardBadge>

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

Ruft einen Badge ab, der die status der Spalten auf dem Board anzeigt.

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

Die ID des Boards.

columnOptions: BoardBadgeColumnOptions

Bestimmt, welche Spalten angezeigt werden sollen.

columns: string[]

Wenn columnOptions auf benutzerdefiniert festgelegt ist, geben Sie die Liste der Spaltennamen an.

Gibt zurück

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Abrufen von Board- Karte Regeleinstellungen für die Board-ID oder das Board nach Name

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Gibt zurück

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Abrufen von Board-Karte-Einstellungen für die Board-ID oder das Board anhand des Namens

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Gibt zurück

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Abrufen eines Boarddiagramms

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Bezeichner für das Board, entweder Name der Backlogebene des Boards (z. B. "Stories") oder ID

name: string

Der Diagrammname

Gibt zurück

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Abrufen von Boarddiagrammen

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Bezeichner für das Board, entweder Name der Backlogebene des Boards (z. B. "Stories") oder ID

Gibt zurück

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Abrufen von Spalten auf einem Board

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Name oder ID des jeweiligen Boards

Gibt zurück

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Gibt die Liste des Filtermodells des übergeordneten Felds für die angegebene Liste der Arbeitselement-IDs zurück.

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

childBacklogContextCategoryRefName: string

workitemIds: number[]

Gibt zurück

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Abrufen von Zeilen auf einem Board

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Name oder ID des jeweiligen Boards

Gibt zurück

Promise<BoardRow[]>

getBoards(TeamContext)

Abrufen von Boards

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Abrufen von Boardbenutzereinstellungen für eine Board-ID

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Board-ID oder Name

Gibt zurück

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Abrufen der Kapazität eines Teams einschließlich Gesamtkapazität und freien Tagen

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

Gibt zurück

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Abrufen der Kapazität eines Teammitglieds

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

teamMemberId: string

ID des Teammitglieds

Gibt zurück

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Abrufen verfügbarer Boardspalten in einem Projekt

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BoardSuggestedValue[]>

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

Abrufen von Übermittlungsansichtsdaten

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

Parameter

project: string

Projekt-ID oder Projektname

id: string

Bezeichner für die Übermittlungsansicht

revision: number

Überarbeitung des Plans, für den Sie Daten benötigen. Wenn der aktuelle Plan eine andere Revision ist, erhalten Sie eine ViewRevisionMismatchException-Ausnahme. Wenn Sie keine Revision bereitstellen, erhalten Sie Daten für die neueste Revision.

startDate: Date

Das Startdatum von Zeitleiste

endDate: Date

Das Enddatum von Zeitleiste

Gibt zurück

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Abrufen von Arbeitselementen für die Iteration

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

Gibt zurück

Promise<IterationWorkItems>

getPlan(string, string)

Abrufen der Informationen für den angegebenen Plan

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

Parameter

project: string

Projekt-ID oder Projektname

id: string

Bezeichner des Plans

Gibt zurück

Promise<Plan>

getPlans(string)

Abrufen der Informationen für alle Pläne, die für das angegebene Team konfiguriert sind

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Plan[]>

getProcessConfiguration(string)

Abrufen der Prozesskonfiguration

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Abrufen verfügbarer Boardzeilen in einem Projekt

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Abrufen der freien Tage des Teams für eine Iteration

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

Gibt zurück

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Abrufen einer Sammlung von Teamfeldwerten

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Abrufen der Iteration des Teams nach IterationId

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

ID der Iteration

Gibt zurück

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Abrufen der Iterationen eines Teams mithilfe des Zeitrahmenfilters

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

timeframe: string

Ein Filter, für den Iterationen basierend auf relativer Zeit zurückgegeben werden. Derzeit wird nur Current unterstützt.

Gibt zurück

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Abrufen der Einstellungen eines Teams

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Abrufen der Kapazität einer Iteration für alle Teams in der Iteration

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

Parameter

project: string

Projekt-ID oder Projektname

iterationId: string

ID der Iteration

Gibt zurück

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parameter

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

Gibt zurück

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Hinzufügen einer Iteration zum Team

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

Parameter

iteration: TeamSettingsIteration

Hinzuzufügende Iteration

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Neuanordnen von Arbeitselementen für Produktbacklog/Boards

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

Parameter

operation: ReorderOperation

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Neuanordnen von Sprint Backlog/Taskboard-Arbeitselementen

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

Parameter

operation: ReorderOperation

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

Die ID der Iteration

Gibt zurück

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Ersetzen der Kapazität eines Teams

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

Parameter

capacities: TeamMemberCapacityIdentityRef[]

Zu ersetzende Teamkapazität

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

Gibt zurück

Promise<TeamMemberCapacityIdentityRef[]>

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

Boardoptionen aktualisieren

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

Parameter

options: {[key: string]: string}

Zu aktualisierende Optionen

teamContext: TeamContext

Der Teamkontext für den Vorgang

id: string

Bezeichner für Board, entweder Kategoriepluralname (z. B.: "Stories") oder GUID

Gibt zurück

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Erstellt/aktualisiert Einstellungen für Automatisierungsregeln

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

Parameter

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Erforderliche Parameter zum Erstellen/Aktualisieren von Automatisierungsregelneinstellungen

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Aktualisieren der Board-Karte Regeleinstellungen für die Board-ID oder das Board nach Name

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

Parameter

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Gibt zurück

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Aktualisieren der Board-Karte Einstellungen für die Board-ID oder das Board nach Name

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

Parameter

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Gibt zurück

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Aktualisieren eines Kartendiagramms

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

Parameter

chart: BoardChart

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Bezeichner für das Board, entweder Name der Backlogebene des Boards (z. B.: "Stories") oder ID

name: string

Der Diagrammname

Gibt zurück

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Aktualisieren von Spalten auf einem Board

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

Parameter

boardColumns: BoardColumn[]

Liste der zu aktualisierenden Boardspalten

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Name oder ID des jeweiligen Boards

Gibt zurück

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Aktualisieren von Zeilen auf einer Platine

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

Parameter

boardRows: BoardRow[]

Liste der zu aktualisierenden Boardzeilen

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Name oder ID des jeweiligen Boards

Gibt zurück

Promise<BoardRow[]>

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

Aktualisieren der Boardbenutzereinstellungen für die Board-ID

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

Parameter

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Der Teamkontext für den Vorgang

board: string

Gibt zurück

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Aktualisieren der Kapazität eines Teammitglieds

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

Parameter

patch: CapacityPatch

Aktualisierte Kapazität

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

teamMemberId: string

ID des Teammitglieds

Gibt zurück

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parameter

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Aktualisieren der Informationen für den angegebenen Plan

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

Parameter

updatedPlan: UpdatePlan

Zu aktualisierende Plandefinition

project: string

Projekt-ID oder Projektname

id: string

Bezeichner des Plans

Gibt zurück

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Aktualisieren von Taskboard- Karte Regeleinstellungen

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

Parameter

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Taskboard-Karte-Einstellungen aktualisieren

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

Parameter

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Festlegen der freien Tage eines Teams für eine Iteration

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

Parameter

daysOffPatch: TeamSettingsDaysOffPatch

Der Patch für die freien Tage des Teams mit einer Liste von Start- und Enddaten

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

ID der Iteration

Gibt zurück

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Aktualisieren von Teamfeldwerten

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

Parameter

patch: TeamFieldValuesPatch

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Aktualisieren der Einstellungen eines Teams

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

Parameter

teamSettingsPatch: TeamSettingsPatch

TeamSettings-Änderungen

teamContext: TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parameter

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Der Teamkontext für den Vorgang

iterationId: string

workItemId: number

Gibt zurück

Promise<void>

Freigeben über

WorkRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

WorkRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

createPlan(CreatePlan, string)

Parameter

Gibt zurück

deletePlan(string, string)

Parameter

Gibt zurück

deleteTeamIteration(TeamContext, string)

Parameter

Gibt zurück

getBacklog(TeamContext, string)

Parameter

Gibt zurück

getBacklogConfigurations(TeamContext)

Parameter

Gibt zurück

getBacklogLevelWorkItems(TeamContext, string)

Parameter

Gibt zurück

getBacklogs(TeamContext)

Parameter

Gibt zurück

getBoard(TeamContext, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

getBoardCardRuleSettings(TeamContext, string)

Parameter

Gibt zurück

getBoardCardSettings(TeamContext, string)

Parameter

Gibt zurück

getBoardChart(TeamContext, string, string)

Parameter

Gibt zurück

getBoardCharts(TeamContext, string)

Parameter

Gibt zurück

getBoardColumns(TeamContext, string)

Parameter

Gibt zurück

getBoardMappingParentItems(TeamContext, string, number[])

Parameter

Gibt zurück

getBoardRows(TeamContext, string)

Parameter

Gibt zurück

getBoards(TeamContext)

Parameter

Gibt zurück

getBoardUserSettings(TeamContext, string)

Parameter

Gibt zurück

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parameter

Gibt zurück

getCapacityWithIdentityRef(TeamContext, string, string)

Parameter

Gibt zurück

getColumns(TeamContext)

Parameter

Gibt zurück

getColumnSuggestedValues(string)

Parameter