WorkRestClient class

Référence

Paquet:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends: RestClientBase

Constructeurs

WorkRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createPlan(CreatePlan, string)	Ajouter un nouveau plan pour l’équipe
deletePlan(string, string)	Supprimer le plan spécifié
deleteTeamIteration(TeamContext, string)	Supprimer l’itération d’une équipe par itérationId
getBacklog(TeamContext, string)	Obtenir un niveau de backlog
getBacklogConfigurations(TeamContext)	Obtient la configuration du backlog pour une équipe
getBacklogLevelWorkItems(TeamContext, string)	Obtenir la liste des éléments de travail au sein d’un niveau de backlog
getBacklogs(TeamContext)	Répertorier tous les niveaux de backlog
getBoard(TeamContext, string)	Obtenir le tableau
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtient un badge qui affiche le status de colonnes sur le tableau.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtient un badge qui affiche le status de colonnes sur le tableau.
getBoardCardRuleSettings(TeamContext, string)	Obtenir les paramètres du tableau carte règle pour l’ID du tableau ou du tableau par nom
getBoardCardSettings(TeamContext, string)	Obtenir les paramètres du tableau carte pour l’ID du tableau ou du tableau par nom
getBoardChart(TeamContext, string, string)	Obtenir un graphique de tableau
getBoardCharts(TeamContext, string)	Obtenir des graphiques de tableau
getBoardColumns(TeamContext, string)	Obtenir des colonnes sur un tableau
getBoardMappingParentItems(TeamContext, string, number[])	Retourne la liste du modèle de filtre de champ parent pour la liste donnée d’ID d’élément de travail.
getBoardRows(TeamContext, string)	Obtenir des lignes sur un tableau
getBoards(TeamContext)	Obtenir des tableaux
getBoardUserSettings(TeamContext, string)	Obtenir les paramètres utilisateur du tableau pour un ID de carte
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Obtenir la capacité d’une équipe, y compris la capacité totale et les jours de congé
getCapacityWithIdentityRef(TeamContext, string, string)	Obtenir la capacité d’un membre de l’équipe
getColumns(TeamContext)
getColumnSuggestedValues(string)	Obtenir des colonnes de tableau disponibles dans un projet
getDeliveryTimelineData(string, string, number, Date, Date)	Obtenir des données d’affichage de remise
getIterationWorkItems(TeamContext, string)	Obtenir des éléments de travail pour l’itération
getPlan(string, string)	Obtenir les informations du plan spécifié
getPlans(string)	Obtenir les informations pour tous les plans configurés pour l’équipe donnée
getProcessConfiguration(string)	Obtenir la configuration du processus
getRowSuggestedValues(string)	Obtenir des lignes de tableau disponibles dans un projet
getTeamDaysOff(TeamContext, string)	Obtenir les jours de congé de l’équipe pour une itération
getTeamFieldValues(TeamContext)	Obtenir une collection de valeurs de champ d’équipe
getTeamIteration(TeamContext, string)	Obtenir l’itération de l’équipe par itérationId
getTeamIterations(TeamContext, string)	Obtenir les itérations d’une équipe à l’aide du filtre de période
getTeamSettings(TeamContext)	Obtenir les paramètres d’une équipe
getTotalIterationCapacities(string, string)	Obtenir la capacité d’une itération pour toutes les équipes en itération
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Ajouter une itération à l’équipe
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Réorganiser les éléments de travail du backlog/tableaux de produit
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Réorganiser les éléments de travail du backlog/du tableau des tâches sprint
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Remplacer la capacité d’une équipe
setBoardOptions({[key: string]: string}, TeamContext, string)	Mettre à jour les options du tableau
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Crée/met à jour des paramètres de règles d’automatisation
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Mettre à jour les paramètres du tableau carte règle pour l’ID de tableau ou le tableau par nom
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Mettre à jour les paramètres du tableau carte pour l’ID de la carte ou le tableau par nom
updateBoardChart(BoardChart, TeamContext, string, string)	Mettre à jour un graphique de tableau
updateBoardColumns(BoardColumn[], TeamContext, string)	Mettre à jour des colonnes sur un tableau
updateBoardRows(BoardRow[], TeamContext, string)	Mettre à jour des lignes sur un tableau
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Mettre à jour les paramètres utilisateur du tableau pour l’ID de tableau
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Mettre à jour la capacité d’un membre d’équipe
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Mettre à jour les informations du plan spécifié
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Mettre à jour les paramètres du tableau des tâches carte règle
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Mettre à jour les paramètres de carte du tableau des tâches
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Définir les jours de congé d’une équipe pour une itération
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Mettre à jour les valeurs des champs d’équipe
updateTeamSettings(TeamSettingsPatch, TeamContext)	Mettre à jour les paramètres d’une équipe
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Détails du constructeur

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createPlan(CreatePlan, string)

Ajouter un nouveau plan pour l’équipe

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

Paramètres

postedPlan: CreatePlan

Définition du plan

project: string

ID de projet ou nom du projet

Retours

Promise<Plan>

deletePlan(string, string)

Supprimer le plan spécifié

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

Paramètres

project: string

ID de projet ou nom du projet

id: string

Identificateur du plan

Retours

Promise<void>

deleteTeamIteration(TeamContext, string)

Supprimer l’itération d’une équipe par itérationId

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

ID de l’itération

Retours

Promise<void>

getBacklog(TeamContext, string)

Obtenir un niveau de backlog

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

ID du niveau du backlog

Retours

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Obtient la configuration du backlog pour une équipe

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Obtenir la liste des éléments de travail au sein d’un niveau de backlog

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

backlogId: string

Retours

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Répertorier tous les niveaux de backlog

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Obtenir le tableau

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

identificateur du tableau, soit le nom du niveau du backlog de la carte (par exemple :"Histoires ») ou l’ID

Retours

Promise<Board>

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

Obtient un badge qui affiche le status de colonnes sur le tableau.

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

ID du tableau.

columnOptions: BoardBadgeColumnOptions

Détermine les colonnes à afficher.

columns: string[]

Si columnOptions est défini sur personnalisé, spécifiez la liste des noms de colonnes.

Retours

Promise<BoardBadge>

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

Obtient un badge qui affiche le status de colonnes sur le tableau.

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

ID du tableau.

columnOptions: BoardBadgeColumnOptions

Détermine les colonnes à afficher.

columns: string[]

Si columnOptions est défini sur personnalisé, spécifiez la liste des noms de colonnes.

Retours

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Obtenir les paramètres du tableau carte règle pour l’ID du tableau ou du tableau par nom

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Retours

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Obtenir les paramètres du tableau carte pour l’ID du tableau ou du tableau par nom

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Retours

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Obtenir un graphique de tableau

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Identificateur du tableau, soit le nom du niveau du backlog de la carte (par exemple :"Histoires ») ou l’ID

name: string

Nom du graphique

Retours

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Obtenir des graphiques de tableau

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Identificateur du tableau, soit le nom du niveau du backlog de la carte (par exemple :"Histoires ») ou l’ID

Retours

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Obtenir des colonnes sur un tableau

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Nom ou ID de la carte spécifique

Retours

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Retourne la liste du modèle de filtre de champ parent pour la liste donnée d’ID d’élément de travail.

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

childBacklogContextCategoryRefName: string

workitemIds: number[]

Retours

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Obtenir des lignes sur un tableau

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Nom ou ID de la carte spécifique

Retours

Promise<BoardRow[]>

getBoards(TeamContext)

Obtenir des tableaux

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Obtenir les paramètres utilisateur du tableau pour un ID de carte

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

ID ou nom de la carte

Retours

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Obtenir la capacité d’une équipe, y compris la capacité totale et les jours de congé

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

Retours

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Obtenir la capacité d’un membre de l’équipe

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

teamMemberId: string

ID du membre de l’équipe

Retours

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Obtenir des colonnes de tableau disponibles dans un projet

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<BoardSuggestedValue[]>

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

Obtenir des données d’affichage de remise

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

Paramètres

project: string

ID de projet ou nom du projet

id: string

Identificateur de la vue remise

revision: number

Révision du plan pour lequel vous souhaitez obtenir des données. Si le plan actuel est une révision différente, vous obtiendrez une exception ViewRevisionMismatchException. Si vous ne fournissez pas de révision, vous obtiendrez des données pour la dernière révision.

startDate: Date

Date de début de chronologie

endDate: Date

Date de fin de chronologie

Retours

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Obtenir des éléments de travail pour l’itération

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

Retours

Promise<IterationWorkItems>

getPlan(string, string)

Obtenir les informations du plan spécifié

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

Paramètres

project: string

ID de projet ou nom du projet

id: string

Identificateur du plan

Retours

Promise<Plan>

getPlans(string)

Obtenir les informations pour tous les plans configurés pour l’équipe donnée

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<Plan[]>

getProcessConfiguration(string)

Obtenir la configuration du processus

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Obtenir des lignes de tableau disponibles dans un projet

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Obtenir les jours de congé de l’équipe pour une itération

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

Retours

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Obtenir une collection de valeurs de champ d’équipe

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Obtenir l’itération de l’équipe par itérationId

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

ID de l’itération

Retours

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Obtenir les itérations d’une équipe à l’aide du filtre de période

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

timeframe: string

Filtre pour lequel les itérations sont retournées en fonction du temps relatif. Seul Current est actuellement pris en charge.

Retours

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Obtenir les paramètres d’une équipe

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Obtenir la capacité d’une itération pour toutes les équipes en itération

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

Paramètres

project: string

ID de projet ou nom du projet

iterationId: string

ID de l’itération

Retours

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

Retours

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Ajouter une itération à l’équipe

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

Paramètres

iteration: TeamSettingsIteration

Itération à ajouter

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Réorganiser les éléments de travail du backlog/tableaux de produit

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

Paramètres

operation: ReorderOperation

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Réorganiser les éléments de travail du backlog/du tableau des tâches sprint

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

Paramètres

operation: ReorderOperation

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

Retours

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Remplacer la capacité d’une équipe

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

Paramètres

capacities: TeamMemberCapacityIdentityRef[]

Capacité d’équipe à remplacer

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

Retours

Promise<TeamMemberCapacityIdentityRef[]>

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

Mettre à jour les options du tableau

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

Paramètres

options: {[key: string]: string}

options à mettre à jour

teamContext: TeamContext

Contexte d’équipe de l’opération

id: string

identificateur pour le tableau, soit le nom pluriel de catégorie (par exemple :"Histoires ») ou le guid

Retours

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Crée/met à jour des paramètres de règles d’automatisation

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

Paramètres

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Paramètres requis pour créer/mettre à jour des paramètres de règles d’automatisation

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Mettre à jour les paramètres du tableau carte règle pour l’ID de tableau ou le tableau par nom

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

Paramètres

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Retours

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Mettre à jour les paramètres du tableau carte pour l’ID de la carte ou le tableau par nom

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

Paramètres

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Retours

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Mettre à jour un graphique de tableau

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

Paramètres

chart: BoardChart

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Identificateur du tableau, soit le nom du niveau du backlog de la carte (par exemple :"Histoires ») ou l’ID

name: string

Nom du graphique

Retours

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Mettre à jour des colonnes sur un tableau

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

Paramètres

boardColumns: BoardColumn[]

Liste des colonnes de tableau à mettre à jour

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Nom ou ID de la carte spécifique

Retours

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Mettre à jour des lignes sur un tableau

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

Paramètres

boardRows: BoardRow[]

Liste des lignes du tableau à mettre à jour

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Nom ou ID de la carte spécifique

Retours

Promise<BoardRow[]>

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

Mettre à jour les paramètres utilisateur du tableau pour l’ID de tableau

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

Paramètres

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Contexte d’équipe de l’opération

board: string

Retours

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Mettre à jour la capacité d’un membre d’équipe

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

Paramètres

patch: CapacityPatch

Capacité mise à jour

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

teamMemberId: string

ID du membre de l’équipe

Retours

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Paramètres

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Mettre à jour les informations du plan spécifié

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

Paramètres

updatedPlan: UpdatePlan

Définition du plan à mettre à jour

project: string

ID de projet ou nom du projet

id: string

Identificateur du plan

Retours

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Mettre à jour les paramètres du tableau des tâches carte règle

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

Paramètres

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Mettre à jour les paramètres de carte du tableau des tâches

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

Paramètres

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Définir les jours de congé d’une équipe pour une itération

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

Paramètres

daysOffPatch: TeamSettingsDaysOffPatch

Correctif jours de congé de l’équipe contenant une liste de dates de début et de fin

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

ID de l’itération

Retours

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Mettre à jour les valeurs des champs d’équipe

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

Paramètres

patch: TeamFieldValuesPatch

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Mettre à jour les paramètres d’une équipe

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

Paramètres

teamSettingsPatch: TeamSettingsPatch

Modifications teamSettings

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Paramètres

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Contexte d’équipe de l’opération

iterationId: string

workItemId: number

Retours

Promise<void>

Partager via

WorkRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

WorkRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

createPlan(CreatePlan, string)

Paramètres

Retours

deletePlan(string, string)

Paramètres

Retours

deleteTeamIteration(TeamContext, string)

Paramètres

Retours

getBacklog(TeamContext, string)

Paramètres

Retours

getBacklogConfigurations(TeamContext)

Paramètres

Retours

getBacklogLevelWorkItems(TeamContext, string)

Paramètres

Retours

getBacklogs(TeamContext)

Paramètres

Retours

getBoard(TeamContext, string)

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

getBoardCardRuleSettings(TeamContext, string)

Paramètres

Retours

getBoardCardSettings(TeamContext, string)

Paramètres

Retours

getBoardChart(TeamContext, string, string)

Paramètres

Retours

getBoardCharts(TeamContext, string)

Paramètres

Retours

getBoardColumns(TeamContext, string)

Paramètres

Retours

getBoardMappingParentItems(TeamContext, string, number[])

Paramètres

Retours

getBoardRows(TeamContext, string)

Paramètres

Retours

getBoards(TeamContext)

Paramètres

Retours

getBoardUserSettings(TeamContext, string)

Paramètres

Retours

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Paramètres

Retours

getCapacityWithIdentityRef(TeamContext, string, string)

Paramètres

Retours

getColumns(TeamContext)

Paramètres

Retours

getColumnSuggestedValues(string)

Paramètres