WorkRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's
- Extends
Constructors
| Work |
Eigenschappen
| RESOURCE_AREA_ID |
Methoden
Constructordetails
WorkRestClient(IVssRestClientOptions)
Eigenschapdetails
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringWaarde van eigenschap
string
Methodedetails
createPlan(CreatePlan, string)
Een nieuw plan voor het team toevoegen
function createPlan(postedPlan: CreatePlan, project: string): Promise<Plan>Parameters
- postedPlan
- CreatePlan
Plandefinitie
- project
-
string
Project-id of projectnaam
Retouren
Promise<Plan>
deletePlan(string, string)
Het opgegeven plan verwijderen
function deletePlan(project: string, id: string): Promise<void>Parameters
- project
-
string
Project-id of projectnaam
- id
-
string
Id van het plan
Retouren
Promise<void>
deleteTeamIteration(TeamContext, string)
De iteratie van een team verwijderen op iterationId
function deleteTeamIteration(teamContext: TeamContext, id: string): Promise<void>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
Id van de iteratie
Retouren
Promise<void>
getBacklog(TeamContext, string)
Een achterstandsniveau ophalen
function getBacklog(teamContext: TeamContext, id: string): Promise<BacklogLevelConfiguration>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
De id van het achterstandsniveau
Retouren
Promise<BacklogLevelConfiguration>
getBacklogConfigurations(TeamContext)
Achterstallenconfiguratie voor een team ophaalt
function getBacklogConfigurations(teamContext: TeamContext): Promise<BacklogConfiguration>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<BacklogConfiguration>
getBacklogLevelWorkItems(TeamContext, string)
Een lijst met werkitems binnen een achterstandsniveau ophalen
function getBacklogLevelWorkItems(teamContext: TeamContext, backlogId: string): Promise<BacklogLevelWorkItems>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- backlogId
-
string
Retouren
Promise<BacklogLevelWorkItems>
getBacklogs(TeamContext)
Alle achterstandsniveaus weergeven
function getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<BacklogLevelConfiguration[]>
getBoard(TeamContext, string)
Bord ophalen
function getBoard(teamContext: TeamContext, id: string): Promise<Board>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
id voor bord, naam van het achterstandsniveau van het bord (bijvoorbeeld:"Verhalen") of id
Retouren
Promise<Board>
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])
Hiermee haalt u een badge op die de status van kolommen op het bord weergeeft.
function getBoardBadge(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<BoardBadge>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
De id van het bord.
- columnOptions
- BoardBadgeColumnOptions
Bepaalt welke kolommen moeten worden weergegeven.
- columns
-
string[]
Als columnOptions is ingesteld op aangepast, geeft u de lijst met kolomnamen op.
Retouren
Promise<BoardBadge>
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])
Hiermee haalt u een badge op die de status van kolommen op het bord weergeeft.
function getBoardBadgeData(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<string>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
De id van het bord.
- columnOptions
- BoardBadgeColumnOptions
Bepaalt welke kolommen moeten worden weergegeven.
- columns
-
string[]
Als columnOptions is ingesteld op aangepast, geeft u de lijst met kolomnamen op.
Retouren
Promise<string>
getBoardCardRuleSettings(TeamContext, string)
Regelinstellingen voor bordkaart ophalen voor de bord-id of bord op naam
function getBoardCardRuleSettings(teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Retouren
Promise<BoardCardRuleSettings>
getBoardCardSettings(TeamContext, string)
Kaartinstellingen ophalen voor de bord-id of bord op naam
function getBoardCardSettings(teamContext: TeamContext, board: string): Promise<BoardCardSettings>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Retouren
Promise<BoardCardSettings>
getBoardChart(TeamContext, string, string)
Een borddiagram ophalen
function getBoardChart(teamContext: TeamContext, board: string, name: string): Promise<BoardChart>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Id voor bord, naam van het achterstallig niveau van het bord (bijvoorbeeld: 'Verhalen') of id
- name
-
string
De grafieknaam
Retouren
Promise<BoardChart>
getBoardCharts(TeamContext, string)
Borddiagrammen ophalen
function getBoardCharts(teamContext: TeamContext, board: string): Promise<BoardChartReference[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Id voor bord, naam van het achterstallig niveau van het bord (bijvoorbeeld: 'Verhalen') of id
Retouren
Promise<BoardChartReference[]>
getBoardColumns(TeamContext, string)
Kolommen op een bord ophalen
function getBoardColumns(teamContext: TeamContext, board: string): Promise<BoardColumn[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Naam of id van het specifieke bord
Retouren
Promise<BoardColumn[]>
getBoardMappingParentItems(TeamContext, string, number[])
Retourneert de lijst met het bovenliggende veldfiltermodel voor de opgegeven lijst met workitem-id's
function getBoardMappingParentItems(teamContext: TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<ParentChildWIMap[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- childBacklogContextCategoryRefName
-
string
- workitemIds
-
number[]
Retouren
Promise<ParentChildWIMap[]>
getBoardRows(TeamContext, string)
Rijen op een bord ophalen
function getBoardRows(teamContext: TeamContext, board: string): Promise<BoardRow[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Naam of id van het specifieke bord
Retouren
Promise<BoardRow[]>
getBoards(TeamContext)
Borden ophalen
function getBoards(teamContext: TeamContext): Promise<BoardReference[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<BoardReference[]>
getBoardUserSettings(TeamContext, string)
Gebruikersinstellingen voor een bord ophalen voor een bord-id
function getBoardUserSettings(teamContext: TeamContext, board: string): Promise<BoardUserSettings>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Bord-id of -naam
Retouren
Promise<BoardUserSettings>
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)
De capaciteit van een team ophalen, inclusief de totale capaciteit en vrije dagen
function getCapacitiesWithIdentityRefAndTotals(teamContext: TeamContext, iterationId: string): Promise<TeamCapacity>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
Retouren
Promise<TeamCapacity>
getCapacityWithIdentityRef(TeamContext, string, string)
De capaciteit van een teamlid ophalen
function getCapacityWithIdentityRef(teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
- teamMemberId
-
string
Id van het teamlid
Retouren
Promise<TeamMemberCapacityIdentityRef>
getColumns(TeamContext)
function getColumns(teamContext: TeamContext): Promise<TaskboardColumns>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TaskboardColumns>
getColumnSuggestedValues(string)
Beschikbare bordkolommen in een project ophalen
function getColumnSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>Parameters
- project
-
string
Project-id of projectnaam
Retouren
Promise<BoardSuggestedValue[]>
getDeliveryTimelineData(string, string, number, Date, Date)
Gegevens van de bezorgingsweergave ophalen
function getDeliveryTimelineData(project: string, id: string, revision?: number, startDate?: Date, endDate?: Date): Promise<DeliveryViewData>Parameters
- project
-
string
Project-id of projectnaam
- id
-
string
Id voor bezorgingsweergave
- revision
-
number
Revisie van het plan waarvoor u gegevens wilt gebruiken. Als het huidige plan een andere revisie is, krijgt u een ViewRevisionMismatchException-uitzondering. Als u geen revisie opgeeft, krijgt u gegevens voor de meest recente revisie.
- startDate
-
Date
De begindatum van de tijdlijn
- endDate
-
Date
De einddatum van de tijdlijn
Retouren
Promise<DeliveryViewData>
getIterationWorkItems(TeamContext, string)
Werkitems ophalen voor iteratie
function getIterationWorkItems(teamContext: TeamContext, iterationId: string): Promise<IterationWorkItems>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
Retouren
Promise<IterationWorkItems>
getPlan(string, string)
De informatie voor het opgegeven plan ophalen
function getPlan(project: string, id: string): Promise<Plan>Parameters
- project
-
string
Project-id of projectnaam
- id
-
string
Id van het plan
Retouren
Promise<Plan>
getPlans(string)
De informatie ophalen voor alle plannen die zijn geconfigureerd voor het opgegeven team
function getPlans(project: string): Promise<Plan[]>Parameters
- project
-
string
Project-id of projectnaam
Retouren
Promise<Plan[]>
getProcessConfiguration(string)
Procesconfiguratie ophalen
function getProcessConfiguration(project: string): Promise<ProcessConfiguration>Parameters
- project
-
string
Project-id of projectnaam
Retouren
Promise<ProcessConfiguration>
getRowSuggestedValues(string)
Beschikbare bordrijen in een project ophalen
function getRowSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>Parameters
- project
-
string
Project-id of projectnaam
Retouren
Promise<BoardSuggestedValue[]>
getTeamDaysOff(TeamContext, string)
Teamdagen vrij krijgen voor een iteratie
function getTeamDaysOff(teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
Retouren
Promise<TeamSettingsDaysOff>
getTeamFieldValues(TeamContext)
Een verzameling teamveldwaarden ophalen
function getTeamFieldValues(teamContext: TeamContext): Promise<TeamFieldValues>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TeamFieldValues>
getTeamIteration(TeamContext, string)
De iteratie van het team ophalen op iterationId
function getTeamIteration(teamContext: TeamContext, id: string): Promise<TeamSettingsIteration>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
Id van de iteratie
Retouren
Promise<TeamSettingsIteration>
getTeamIterations(TeamContext, string)
De iteraties van een team ophalen met behulp van het tijdskaderfilter
function getTeamIterations(teamContext: TeamContext, timeframe?: string): Promise<TeamSettingsIteration[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- timeframe
-
string
Een filter waarvoor iteraties worden geretourneerd op basis van relatieve tijd. Alleen Current wordt momenteel ondersteund.
Retouren
Promise<TeamSettingsIteration[]>
getTeamSettings(TeamContext)
De instellingen van een team ophalen
function getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TeamSetting>
getTotalIterationCapacities(string, string)
De capaciteit van een iteratie ophalen voor alle teams in iteratie
function getTotalIterationCapacities(project: string, iterationId: string): Promise<IterationCapacity>Parameters
- project
-
string
Project-id of projectnaam
- iterationId
-
string
Id van de iteratie
Retouren
Promise<IterationCapacity>
getWorkItemColumns(TeamContext, string)
function getWorkItemColumns(teamContext: TeamContext, iterationId: string): Promise<TaskboardWorkItemColumn[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Retouren
Promise<TaskboardWorkItemColumn[]>
postTeamIteration(TeamSettingsIteration, TeamContext)
Een iteratie toevoegen aan het team
function postTeamIteration(iteration: TeamSettingsIteration, teamContext: TeamContext): Promise<TeamSettingsIteration>Parameters
- iteration
- TeamSettingsIteration
Toe te voegen iteratie
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TeamSettingsIteration>
reorderBacklogWorkItems(ReorderOperation, TeamContext)
Productachterstand/borden werkitems opnieuw ordenen
function reorderBacklogWorkItems(operation: ReorderOperation, teamContext: TeamContext): Promise<ReorderResult[]>Parameters
- operation
- ReorderOperation
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<ReorderResult[]>
reorderIterationWorkItems(ReorderOperation, TeamContext, string)
Volgorde sprintachterstand/taakbordwerkitems opnieuw ordenen
function reorderIterationWorkItems(operation: ReorderOperation, teamContext: TeamContext, iterationId: string): Promise<ReorderResult[]>Parameters
- operation
- ReorderOperation
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
De id van de iteratie
Retouren
Promise<ReorderResult[]>
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)
De capaciteit van een team vervangen
function replaceCapacitiesWithIdentityRef(capacities: TeamMemberCapacityIdentityRef[], teamContext: TeamContext, iterationId: string): Promise<TeamMemberCapacityIdentityRef[]>Parameters
- capacities
Teamcapaciteit om te vervangen
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
Retouren
Promise<TeamMemberCapacityIdentityRef[]>
setBoardOptions({[key: string]: string}, TeamContext, string)
Opties voor het bijwerken van bord
function setBoardOptions(options: {[key: string]: string}, teamContext: TeamContext, id: string): Promise<{[key: string]: string}>Parameters
- options
-
{[key: string]: string}
opties voor het bijwerken van
- teamContext
- TeamContext
De teamcontext voor de bewerking
- id
-
string
id voor bord, categorie meervoudnaam (bijvoorbeeld: Verhalen) of GUID
Retouren
Promise<{[key: string]: string}>
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)
Instellingen voor automatiseringsregels maken/bijwerken
function updateAutomationRule(ruleRequestModel: TeamAutomationRulesSettingsRequestModel, teamContext: TeamContext): Promise<void>Parameters
- ruleRequestModel
- TeamAutomationRulesSettingsRequestModel
Vereiste parameters voor het maken/bijwerken van instellingen voor automatiseringsregels
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<void>
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)
Regelinstellingen voor bordkaarten bijwerken voor de bord-id of bord op naam
function updateBoardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>Parameters
- boardCardRuleSettings
- BoardCardRuleSettings
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Retouren
Promise<BoardCardRuleSettings>
updateBoardCardSettings(BoardCardSettings, TeamContext, string)
De instellingen van de bordkaart voor de bord-id of het bord op naam bijwerken
function updateBoardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext, board: string): Promise<BoardCardSettings>Parameters
- boardCardSettingsToSave
- BoardCardSettings
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Retouren
Promise<BoardCardSettings>
updateBoardChart(BoardChart, TeamContext, string, string)
Een borddiagram bijwerken
function updateBoardChart(chart: BoardChart, teamContext: TeamContext, board: string, name: string): Promise<BoardChart>Parameters
- chart
- BoardChart
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Id voor bord, naam van het achterstandsniveau van het bord (bijvoorbeeld: Verhalen) of id
- name
-
string
De grafieknaam
Retouren
Promise<BoardChart>
updateBoardColumns(BoardColumn[], TeamContext, string)
Kolommen op een bord bijwerken
function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>Parameters
- boardColumns
Lijst met bij te werken bordkolommen
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Naam of id van het specifieke bord
Retouren
Promise<BoardColumn[]>
updateBoardRows(BoardRow[], TeamContext, string)
Rijen op een bord bijwerken
function updateBoardRows(boardRows: BoardRow[], teamContext: TeamContext, board: string): Promise<BoardRow[]>Parameters
- boardRows
-
BoardRow[]
Lijst met bij te werken bordrijen
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Naam of id van het specifieke bord
Retouren
Promise<BoardRow[]>
updateBoardUserSettings({[key: string]: string}, TeamContext, string)
De gebruikersinstellingen van het bord voor de bord-id bijwerken
function updateBoardUserSettings(boardUserSettings: {[key: string]: string}, teamContext: TeamContext, board: string): Promise<BoardUserSettings>Parameters
- boardUserSettings
-
{[key: string]: string}
- teamContext
- TeamContext
De teamcontext voor de bewerking
- board
-
string
Retouren
Promise<BoardUserSettings>
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)
De capaciteit van een teamlid bijwerken
function updateCapacityWithIdentityRef(patch: CapacityPatch, teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>Parameters
- patch
- CapacityPatch
Bijgewerkte capaciteit
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
- teamMemberId
-
string
Id van het teamlid
Retouren
Promise<TeamMemberCapacityIdentityRef>
updateColumns(UpdateTaskboardColumn[], TeamContext)
function updateColumns(updateColumns: UpdateTaskboardColumn[], teamContext: TeamContext): Promise<TaskboardColumns>Parameters
- updateColumns
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TaskboardColumns>
updatePlan(UpdatePlan, string, string)
De informatie voor het opgegeven plan bijwerken
function updatePlan(updatedPlan: UpdatePlan, project: string, id: string): Promise<Plan>Parameters
- updatedPlan
- UpdatePlan
Plandefinitie die moet worden bijgewerkt
- project
-
string
Project-id of projectnaam
- id
-
string
Id van het plan
Retouren
Promise<Plan>
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)
Instellingen voor de taakbordkaartregel bijwerken
function updateTaskboardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext): Promise<void>Parameters
- boardCardRuleSettings
- BoardCardRuleSettings
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<void>
updateTaskboardCardSettings(BoardCardSettings, TeamContext)
Taskboard-kaartinstellingen bijwerken
function updateTaskboardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext): Promise<void>Parameters
- boardCardSettingsToSave
- BoardCardSettings
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<void>
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)
De vrije dagen van een team instellen voor een herhaling
function updateTeamDaysOff(daysOffPatch: TeamSettingsDaysOffPatch, teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>Parameters
- daysOffPatch
- TeamSettingsDaysOffPatch
Patch voor vrije dagen van team met een lijst met begin- en einddatums
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
Id van de iteratie
Retouren
Promise<TeamSettingsDaysOff>
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)
Teamveldwaarden bijwerken
function updateTeamFieldValues(patch: TeamFieldValuesPatch, teamContext: TeamContext): Promise<TeamFieldValues>Parameters
- patch
- TeamFieldValuesPatch
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TeamFieldValues>
updateTeamSettings(TeamSettingsPatch, TeamContext)
De instellingen van een team bijwerken
function updateTeamSettings(teamSettingsPatch: TeamSettingsPatch, teamContext: TeamContext): Promise<TeamSetting>Parameters
- teamSettingsPatch
- TeamSettingsPatch
Wijzigingen in TeamSettings
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<TeamSetting>
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)
function updateWorkItemColumn(updateColumn: UpdateTaskboardWorkItemColumn, teamContext: TeamContext, iterationId: string, workItemId: number): Promise<void>Parameters
- updateColumn
- UpdateTaskboardWorkItemColumn
- teamContext
- TeamContext
De teamcontext voor de bewerking
- iterationId
-
string
- workItemId
-
number
Retouren
Promise<void>