WorkRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends: RestClientBase

Konstruktorer

WorkRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

createPlan(CreatePlan, string)	Lägga till en ny plan för teamet
deletePlan(string, string)	Ta bort den angivna planen
deleteTeamIteration(TeamContext, string)	Ta bort ett teams iteration med iterationId
getBacklog(TeamContext, string)	Hämta en kvarvarande nivå
getBacklogConfigurations(TeamContext)	Hämtar konfiguration av kvarvarande uppgifter för ett team
getBacklogLevelWorkItems(TeamContext, string)	Hämta en lista över arbetsobjekt inom en eftersläpningsnivå
getBacklogs(TeamContext)	Visa en lista över alla kvarvarande nivåer
getBoard(TeamContext, string)	Hämta anslagstavlan
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Hämtar ett märke som visar status för kolumner på tavlan.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Hämtar ett märke som visar status för kolumner på tavlan.
getBoardCardRuleSettings(TeamContext, string)	Hämta inställningarna för kortets regelinställningar för bräd-ID eller anslagstavlan efter namn
getBoardCardSettings(TeamContext, string)	Hämta inställningarna för kortets ID eller anslagstavlan efter namn
getBoardChart(TeamContext, string, string)	Hämta ett bräddiagram
getBoardCharts(TeamContext, string)	Hämta bräddiagram
getBoardColumns(TeamContext, string)	Hämta kolumner på ett bräde
getBoardMappingParentItems(TeamContext, string, number[])	Returnerar listan över överordnad fältfiltermodell för den angivna listan över workitem-ID:t
getBoardRows(TeamContext, string)	Hämta rader på en tavla
getBoards(TeamContext)	Hämta anslagstavlor
getBoardUserSettings(TeamContext, string)	Hämta användarinställningar för ett bräd-ID
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Hämta ett teams kapacitet, inklusive total kapacitet och lediga dagar
getCapacityWithIdentityRef(TeamContext, string, string)	Hämta en gruppmedlems kapacitet
getColumns(TeamContext)
getColumnSuggestedValues(string)	Hämta tillgängliga brädkolumner i ett projekt
getDeliveryTimelineData(string, string, number, Date, Date)	Hämta data för leveransvyn
getIterationWorkItems(TeamContext, string)	Hämta arbetsobjekt för iteration
getPlan(string, string)	Hämta informationen för den angivna planen
getPlans(string)	Hämta informationen för alla planer som konfigurerats för det angivna teamet
getProcessConfiguration(string)	Hämta processkonfiguration
getRowSuggestedValues(string)	Hämta tillgängliga brädrader i ett projekt
getTeamDaysOff(TeamContext, string)	Få teamets lediga dagar för en iteration
getTeamFieldValues(TeamContext)	Hämta en samling teamfältvärden
getTeamIteration(TeamContext, string)	Hämta teamets iteration med iterationId
getTeamIterations(TeamContext, string)	Hämta ett teams iterationer med hjälp av tidsramsfilter
getTeamSettings(TeamContext)	Hämta ett teams inställningar
getTotalIterationCapacities(string, string)	Hämta en iterations kapacitet för alla team i iteration
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Lägga till en iteration i teamet
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Ändra ordning på arbetsobjekt för produktlista/tavlor
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Ändra ordning på arbetsobjekt för Sprint Backlog/Taskboard
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Ersätta ett teams kapacitet
setBoardOptions({[key: string]: string}, TeamContext, string)	Alternativ för uppdateringstavla
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Skapar/uppdaterar inställningar för automatiseringsregler
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Uppdatera brädkortet Regelinställningar för styrelse-ID eller tavla efter namn
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Uppdatera inställningarna för brädkortets ID eller tavla efter namn
updateBoardChart(BoardChart, TeamContext, string, string)	Uppdatera ett bräddiagram
updateBoardColumns(BoardColumn[], TeamContext, string)	Uppdatera kolumner på ett bräde
updateBoardRows(BoardRow[], TeamContext, string)	Uppdatera rader på en tavla
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Uppdatera tavlans användarinställningar för bräd-ID:t
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Uppdatera en gruppmedlems kapacitet
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Uppdatera informationen för den angivna planen
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Uppdatera regelinställningar för aktivitetskort
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Uppdatera inställningarna för aktivitetskort
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Ange ett teams lediga dagar för en iteration
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Uppdatera fältvärden för team
updateTeamSettings(TeamSettingsPatch, TeamContext)	Uppdatera ett teams inställningar
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Konstruktorinformation

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

createPlan(CreatePlan, string)

Lägga till en ny plan för teamet

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

Parametrar

postedPlan: CreatePlan

Plandefinition

project: string

Projekt-ID eller projektnamn

Returer

Promise<Plan>

deletePlan(string, string)

Ta bort den angivna planen

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

Parametrar

project: string

Projekt-ID eller projektnamn

id: string

Identifierare för planen

Returer

Promise<void>

deleteTeamIteration(TeamContext, string)

Ta bort ett teams iteration med iterationId

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

ID för iterationen

Returer

Promise<void>

getBacklog(TeamContext, string)

Hämta en kvarvarande nivå

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

ID:t för kvarvarande uppgifter

Returer

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Hämtar konfiguration av kvarvarande uppgifter för ett team

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Hämta en lista över arbetsobjekt inom en eftersläpningsnivå

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

backlogId: string

Returer

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Visa en lista över alla kvarvarande nivåer

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Hämta anslagstavlan

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

identifierare för bräde, antingen brädets namn på kvarvarande uppgifter (t.ex. "Stories") eller ID

Returer

Promise<Board>

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

Hämtar ett märke som visar status för kolumner på tavlan.

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

Kortets ID.

columnOptions: BoardBadgeColumnOptions

Avgör vilka kolumner som ska visas.

columns: string[]

Om columnOptions är inställt på anpassat anger du listan med kolumnnamn.

Returer

Promise<BoardBadge>

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

Hämtar ett märke som visar status för kolumner på tavlan.

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

Kortets ID.

columnOptions: BoardBadgeColumnOptions

Avgör vilka kolumner som ska visas.

columns: string[]

Om columnOptions är inställt på anpassat anger du listan med kolumnnamn.

Returer

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Hämta inställningarna för kortets regelinställningar för bräd-ID eller anslagstavlan efter namn

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Returer

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Hämta inställningarna för kortets ID eller anslagstavlan efter namn

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Returer

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Hämta ett bräddiagram

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Identifierare för bräde, antingen kortets namn på kvarvarande uppgifter (t.ex. "Stories") eller ID

name: string

Diagramnamnet

Returer

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Hämta bräddiagram

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Identifierare för bräde, antingen kortets namn på kvarvarande uppgifter (t.ex. "Stories") eller ID

Returer

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Hämta kolumner på ett bräde

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Namn eller ID för den specifika anslagstavlan

Returer

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Returnerar listan över överordnad fältfiltermodell för den angivna listan över workitem-ID:t

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

childBacklogContextCategoryRefName: string

workitemIds: number[]

Returer

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Hämta rader på en tavla

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Namn eller ID för den specifika anslagstavlan

Returer

Promise<BoardRow[]>

getBoards(TeamContext)

Hämta anslagstavlor

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Hämta användarinställningar för ett bräd-ID

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Bräd-ID eller namn

Returer

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Hämta ett teams kapacitet, inklusive total kapacitet och lediga dagar

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

Returer

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Hämta en gruppmedlems kapacitet

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

teamMemberId: string

ID för teammedlemmen

Returer

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Hämta tillgängliga brädkolumner i ett projekt

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<BoardSuggestedValue[]>

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

Hämta data för leveransvyn

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

Parametrar

project: string

Projekt-ID eller projektnamn

id: string

Identifierare för leveransvy

revision: number

Revision av den plan som du vill ha data för. Om den aktuella planen är en annan revision får du ett ViewRevisionMismatchException-undantag. Om du inte anger någon revision får du data för den senaste revisionen.

startDate: Date

Tidslinjens startdatum

endDate: Date

Tidslinjens slutdatum

Returer

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Hämta arbetsobjekt för iteration

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

Returer

Promise<IterationWorkItems>

getPlan(string, string)

Hämta informationen för den angivna planen

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

Parametrar

project: string

Projekt-ID eller projektnamn

id: string

Identifierare för planen

Returer

Promise<Plan>

getPlans(string)

Hämta informationen för alla planer som konfigurerats för det angivna teamet

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<Plan[]>

getProcessConfiguration(string)

Hämta processkonfiguration

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Hämta tillgängliga brädrader i ett projekt

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Få teamets lediga dagar för en iteration

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

Returer

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Hämta en samling teamfältvärden

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Hämta teamets iteration med iterationId

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

ID för iterationen

Returer

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Hämta ett teams iterationer med hjälp av tidsramsfilter

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

timeframe: string

Ett filter som iterationer returneras för baserat på relativ tid. Endast Aktuell stöds för närvarande.

Returer

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Hämta ett teams inställningar

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Hämta en iterations kapacitet för alla team i iteration

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

Parametrar

project: string

Projekt-ID eller projektnamn

iterationId: string

ID för iterationen

Returer

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

Returer

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Lägga till en iteration i teamet

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

Parametrar

iteration: TeamSettingsIteration

Iteration att lägga till

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Ändra ordning på arbetsobjekt för produktlista/tavlor

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

Parametrar

operation: ReorderOperation

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Ändra ordning på arbetsobjekt för Sprint Backlog/Taskboard

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

Parametrar

operation: ReorderOperation

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

Iterationens ID

Returer

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Ersätta ett teams kapacitet

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

Parametrar

capacities: TeamMemberCapacityIdentityRef[]

Teamkapacitet att ersätta

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

Returer

Promise<TeamMemberCapacityIdentityRef[]>

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

Alternativ för uppdateringstavla

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

Parametrar

options: {[key: string]: string}

alternativ för uppdatering

teamContext: TeamContext

Teamkontexten för åtgärden

id: string

identifierare för bräde, antingen kategori pluralnamn (t.ex.:"Berättelser") eller GUID

Returer

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Skapar/uppdaterar inställningar för automatiseringsregler

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

Parametrar

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Obligatoriska parametrar för att skapa/uppdatera inställningar för automatiseringsregler

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Uppdatera brädkortet Regelinställningar för styrelse-ID eller tavla efter namn

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

Parametrar

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Returer

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Uppdatera inställningarna för brädkortets ID eller tavla efter namn

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

Parametrar

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Returer

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Uppdatera ett bräddiagram

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

Parametrar

chart: BoardChart

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Identifierare för tavla, antingen kortets namn på kvarvarande uppgifter (t.ex. "Berättelser") eller ID

name: string

Diagramnamnet

Returer

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Uppdatera kolumner på ett bräde

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

Parametrar

boardColumns: BoardColumn[]

Lista över brädkolumner som ska uppdateras

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Namn eller ID för den specifika tavlan

Returer

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Uppdatera rader på en tavla

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

Parametrar

boardRows: BoardRow[]

Lista över styrelserader som ska uppdateras

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Namn eller ID för den specifika tavlan

Returer

Promise<BoardRow[]>

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

Uppdatera tavlans användarinställningar för bräd-ID:t

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

Parametrar

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Teamkontexten för åtgärden

board: string

Returer

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Uppdatera en gruppmedlems kapacitet

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

Parametrar

patch: CapacityPatch

Uppdaterad kapacitet

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

teamMemberId: string

ID för teammedlemmen

Returer

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parametrar

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Uppdatera informationen för den angivna planen

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

Parametrar

updatedPlan: UpdatePlan

Plandefinition som ska uppdateras

project: string

Projekt-ID eller projektnamn

id: string

Planens identifierare

Returer

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Uppdatera regelinställningar för aktivitetskort

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

Parametrar

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Uppdatera inställningarna för aktivitetskort

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

Parametrar

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Ange ett teams lediga dagar för en iteration

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

Parametrar

daysOffPatch: TeamSettingsDaysOffPatch

Teamets lediga dagar med en lista över start- och slutdatum

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

ID för iterationen

Returer

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Uppdatera fältvärden för team

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

Parametrar

patch: TeamFieldValuesPatch

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Uppdatera ett teams inställningar

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

Parametrar

teamSettingsPatch: TeamSettingsPatch

Ändringar i TeamSettings

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parametrar

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Teamkontexten för åtgärden

iterationId: string

workItemId: number

Returer

Promise<void>

Dela via

WorkRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

WorkRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

createPlan(CreatePlan, string)

Parametrar

Returer

deletePlan(string, string)

Parametrar

Returer

deleteTeamIteration(TeamContext, string)

Parametrar

Returer

getBacklog(TeamContext, string)

Parametrar

Returer

getBacklogConfigurations(TeamContext)

Parametrar

Returer

getBacklogLevelWorkItems(TeamContext, string)

Parametrar

Returer

getBacklogs(TeamContext)

Parametrar

Returer

getBoard(TeamContext, string)

Parametrar

Returer

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

Parametrar

Returer

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

Parametrar

Returer

getBoardCardRuleSettings(TeamContext, string)

Parametrar

Returer

getBoardCardSettings(TeamContext, string)

Parametrar

Returer

getBoardChart(TeamContext, string, string)

Parametrar

Returer

getBoardCharts(TeamContext, string)

Parametrar

Returer

getBoardColumns(TeamContext, string)

Parametrar

Returer

getBoardMappingParentItems(TeamContext, string, number[])

Parametrar

Returer

getBoardRows(TeamContext, string)

Parametrar

Returer

getBoards(TeamContext)

Parametrar

Returer

getBoardUserSettings(TeamContext, string)

Parametrar

Returer

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parametrar

Returer

getCapacityWithIdentityRef(TeamContext, string, string)

Parametrar

Returer

getColumns(TeamContext)

Parametrar

Returer

getColumnSuggestedValues(string)

Parametrar