WorkRestClient class

Referencia

Paquete:: azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends: RestClientBase

Constructores

WorkRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createPlan(CreatePlan, string)	Agregar un nuevo plan para el equipo
deletePlan(string, string)	Eliminar el plan especificado
deleteTeamIteration(TeamContext, string)	Eliminar la iteración de un equipo por iteraciónId
getBacklog(TeamContext, string)	Obtener un nivel de trabajo pendiente
getBacklogConfigurations(TeamContext)	Obtiene la configuración del trabajo pendiente de un equipo.
getBacklogLevelWorkItems(TeamContext, string)	Obtener una lista de elementos de trabajo dentro de un nivel de trabajo pendiente
getBacklogs(TeamContext)	Enumeración de todos los niveles de trabajo pendiente
getBoard(TeamContext, string)	Obtener panel
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtiene un distintivo que muestra el estado de las columnas de la placa.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Obtiene un distintivo que muestra el estado de las columnas de la placa.
getBoardCardRuleSettings(TeamContext, string)	Obtener la configuración de la regla de tarjeta del panel para el identificador de la placa o el panel por nombre
getBoardCardSettings(TeamContext, string)	Obtener la configuración de la tarjeta del panel para el id. de panel o panel por nombre
getBoardChart(TeamContext, string, string)	Obtener un gráfico de tableros
getBoardCharts(TeamContext, string)	Obtener gráficos de tableros
getBoardColumns(TeamContext, string)	Obtener columnas en un panel
getBoardMappingParentItems(TeamContext, string, number[])	Devuelve la lista del modelo de filtro de campo primario para la lista especificada de identificadores de workitem.
getBoardRows(TeamContext, string)	Obtener filas en un panel
getBoards(TeamContext)	Obtener paneles
getBoardUserSettings(TeamContext, string)	Obtención de la configuración de usuario de la placa para un identificador de panel
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Obtención de la capacidad de un equipo, incluida la capacidad total y los días desconectados
getCapacityWithIdentityRef(TeamContext, string, string)	Obtener la capacidad de un miembro del equipo
getColumns(TeamContext)
getColumnSuggestedValues(string)	Obtención de columnas de panel disponibles en un proyecto
getDeliveryTimelineData(string, string, number, Date, Date)	Obtener datos de vista de entrega
getIterationWorkItems(TeamContext, string)	Obtención de elementos de trabajo para la iteración
getPlan(string, string)	Obtención de la información del plan especificado
getPlans(string)	Obtención de la información de todos los planes configurados para el equipo determinado
getProcessConfiguration(string)	Obtención de la configuración del proceso
getRowSuggestedValues(string)	Obtener filas de panel disponibles en un proyecto
getTeamDaysOff(TeamContext, string)	Obtener los días del equipo fuera de una iteración
getTeamFieldValues(TeamContext)	Obtener una colección de valores de campo de equipo
getTeamIteration(TeamContext, string)	Obtención de la iteración del equipo por iteraciónId
getTeamIterations(TeamContext, string)	Obtención de iteraciones de un equipo mediante el filtro de período de tiempo
getTeamSettings(TeamContext)	Obtener la configuración de un equipo
getTotalIterationCapacities(string, string)	Obtener la capacidad de una iteración para todos los equipos en iteración
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Agregar una iteración al equipo
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Reordenar elementos de trabajo de trabajos pendientes o paneles del producto
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Reordenar elementos de trabajo del trabajo pendiente o del panel de tareas de Sprint
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Reemplazar la capacidad de un equipo
setBoardOptions({[key: string]: string}, TeamContext, string)	Actualizar las opciones del panel
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Crea o actualiza una configuración de reglas de automatización.
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Actualizar la configuración de la regla de tarjeta del panel para el identificador de la placa o el panel por nombre
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Actualizar la configuración de la tarjeta de la placa para el identificador o panel por nombre
updateBoardChart(BoardChart, TeamContext, string, string)	Actualizar un gráfico de tableros
updateBoardColumns(BoardColumn[], TeamContext, string)	Actualizar columnas en un panel
updateBoardRows(BoardRow[], TeamContext, string)	Actualizar filas en un panel
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Actualizar la configuración de usuario de la placa para el identificador del panel
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Actualizar la capacidad de un miembro del equipo
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Actualizar la información del plan especificado
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Actualizar la configuración de la regla de la tarjeta del panel de tareas
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Actualizar la configuración de la tarjeta del panel de tareas
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Establecer los días de espera de un equipo para una iteración
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Actualizar valores de campo de equipo
updateTeamSettings(TeamSettingsPatch, TeamContext)	Actualizar la configuración de un equipo
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Detalles del constructor

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parámetros

options: IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createPlan(CreatePlan, string)

Agregar un nuevo plan para el equipo

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

Parámetros

postedPlan: CreatePlan

Definición del plan

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Plan>

deletePlan(string, string)

Eliminar el plan especificado

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

id: string

Identificador del plan

Devoluciones

Promise<void>

deleteTeamIteration(TeamContext, string)

Eliminar la iteración de un equipo por iteraciónId

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

id: string

Identificador de la iteración

Devoluciones

Promise<void>

getBacklog(TeamContext, string)

Obtener un nivel de trabajo pendiente

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

id: string

Identificador del nivel de trabajo pendiente

Devoluciones

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Obtiene la configuración del trabajo pendiente de un equipo.

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Obtener una lista de elementos de trabajo dentro de un nivel de trabajo pendiente

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

backlogId: string

Devoluciones

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Enumeración de todos los niveles de trabajo pendiente

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Obtener panel

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

id: string

identificador de la placa, nombre del nivel de trabajo pendiente de la placa (Eg:"Stories") o Id.

Devoluciones

Promise<Board>

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

Obtiene un distintivo que muestra el estado de las columnas de la placa.

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

id: string

Identificador del panel.

columnOptions: BoardBadgeColumnOptions

Determina qué columnas se van a mostrar.

columns: string[]

Si columnOptions está establecido en personalizado, especifique la lista de nombres de columna.

Devoluciones

Promise<BoardBadge>

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

Obtiene un distintivo que muestra el estado de las columnas de la placa.

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

id: string

Identificador del panel.

columnOptions: BoardBadgeColumnOptions

Determina qué columnas se van a mostrar.

columns: string[]

Si columnOptions está establecido en personalizado, especifique la lista de nombres de columna.

Devoluciones

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Obtener la configuración de la regla de tarjeta del panel para el identificador de la placa o el panel por nombre

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Devoluciones

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Obtener la configuración de la tarjeta del panel para el id. de panel o panel por nombre

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Devoluciones

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Obtener un gráfico de tableros

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Identificador de la placa, nombre del nivel de trabajo pendiente de la placa (Eg:"Stories") o Id.

name: string

Nombre del gráfico

Devoluciones

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Obtener gráficos de tableros

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Identificador de la placa, nombre del nivel de trabajo pendiente de la placa (Eg:"Stories") o Id.

Devoluciones

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Obtener columnas en un panel

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Nombre o identificador de la placa específica

Devoluciones

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Devuelve la lista del modelo de filtro de campo primario para la lista especificada de identificadores de workitem.

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

childBacklogContextCategoryRefName: string

workitemIds: number[]

Devoluciones

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Obtener filas en un panel

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Nombre o identificador de la placa específica

Devoluciones

Promise<BoardRow[]>

getBoards(TeamContext)

Obtener paneles

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Obtención de la configuración de usuario de la placa para un identificador de panel

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Id. de panel o nombre

Devoluciones

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Obtención de la capacidad de un equipo, incluida la capacidad total y los días desconectados

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

Devoluciones

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Obtener la capacidad de un miembro del equipo

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

teamMemberId: string

Identificador del miembro del equipo

Devoluciones

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Obtención de columnas de panel disponibles en un proyecto

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BoardSuggestedValue[]>

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

Obtener datos de vista de entrega

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

id: string

Identificador de la vista de entrega

revision: number

Revisión del plan para el que desea datos. Si el plan actual es una revisión diferente, obtendrá una excepción ViewRevisionMismatchException. Si no proporciona una revisión, obtendrá datos para la revisión más reciente.

startDate: Date

La fecha de inicio de la escala de tiempo

endDate: Date

Fecha de finalización de la escala de tiempo

Devoluciones

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Obtención de elementos de trabajo para la iteración

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

Devoluciones

Promise<IterationWorkItems>

getPlan(string, string)

Obtención de la información del plan especificado

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

id: string

Identificador del plan

Devoluciones

Promise<Plan>

getPlans(string)

Obtención de la información de todos los planes configurados para el equipo determinado

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Plan[]>

getProcessConfiguration(string)

Obtención de la configuración del proceso

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Obtener filas de panel disponibles en un proyecto

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Obtener los días del equipo fuera de una iteración

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

Devoluciones

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Obtener una colección de valores de campo de equipo

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Obtención de la iteración del equipo por iteraciónId

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

id: string

Identificador de la iteración

Devoluciones

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Obtención de iteraciones de un equipo mediante el filtro de período de tiempo

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

timeframe: string

Filtro para el que se devuelven iteraciones en función del tiempo relativo. Actualmente solo se admite Current.

Devoluciones

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Obtener la configuración de un equipo

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Obtener la capacidad de una iteración para todos los equipos en iteración

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

iterationId: string

Identificador de la iteración

Devoluciones

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parámetros

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Devoluciones

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Agregar una iteración al equipo

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

Parámetros

iteration: TeamSettingsIteration

Iteración que se va a agregar

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Reordenar elementos de trabajo de trabajos pendientes o paneles del producto

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

Parámetros

operation: ReorderOperation

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Reordenar elementos de trabajo del trabajo pendiente o del panel de tareas de Sprint

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

Parámetros

operation: ReorderOperation

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

Devoluciones

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Reemplazar la capacidad de un equipo

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

Parámetros

capacities: TeamMemberCapacityIdentityRef[]

Capacidad del equipo que se va a reemplazar

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

Devoluciones

Promise<TeamMemberCapacityIdentityRef[]>

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

Actualizar las opciones del panel

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

Parámetros

options: {[key: string]: string}

opciones para actualizar

teamContext: TeamContext

Contexto del equipo para la operación

id: string

identificador del panel, ya sea el nombre del plural de categoría (Eg:"Stories") o guid

Devoluciones

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Crea o actualiza una configuración de reglas de automatización.

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

Parámetros

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Parámetros necesarios para crear o actualizar una configuración de reglas de automatización

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Actualizar la configuración de la regla de tarjeta del panel para el identificador de la placa o el panel por nombre

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

Parámetros

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Devoluciones

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Actualizar la configuración de la tarjeta de la placa para el identificador o panel por nombre

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

Parámetros

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Devoluciones

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Actualizar un gráfico de tableros

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

Parámetros

chart: BoardChart

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Identificador de la placa, nombre del nivel de trabajo pendiente de la placa (eg:"Stories") o id.

name: string

El nombre del gráfico

Devoluciones

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Actualizar columnas en un panel

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

Parámetros

boardColumns: BoardColumn[]

Lista de columnas de panel que se van a actualizar

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Nombre o identificador de la placa específica

Devoluciones

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Actualizar filas en un panel

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

Parámetros

boardRows: BoardRow[]

Lista de filas de panel que se van a actualizar

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Nombre o identificador de la placa específica

Devoluciones

Promise<BoardRow[]>

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

Actualizar la configuración de usuario de la placa para el identificador del panel

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

Parámetros

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Contexto del equipo para la operación

board: string

Devoluciones

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Actualizar la capacidad de un miembro del equipo

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

Parámetros

patch: CapacityPatch

Capacidad actualizada

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

teamMemberId: string

Identificador del miembro del equipo

Devoluciones

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parámetros

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Actualizar la información del plan especificado

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

Parámetros

updatedPlan: UpdatePlan

Definición del plan que se va a actualizar

project: string

Id. de proyecto o nombre del proyecto

id: string

Identificador del plan

Devoluciones

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Actualizar la configuración de la regla de la tarjeta del panel de tareas

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

Parámetros

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Actualizar la configuración de la tarjeta del panel de tareas

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

Parámetros

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Establecer los días de espera de un equipo para una iteración

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

Parámetros

daysOffPatch: TeamSettingsDaysOffPatch

Revisión de días de expiración del equipo que contiene una lista de fechas de inicio y finalización

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

Identificador de la iteración

Devoluciones

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Actualizar valores de campo de equipo

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

Parámetros

patch: TeamFieldValuesPatch

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Actualizar la configuración de un equipo

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

Parámetros

teamSettingsPatch: TeamSettingsPatch

Cambios en TeamSettings

teamContext: TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parámetros

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Contexto del equipo para la operación

iterationId: string

workItemId: number

Devoluciones

Promise<void>

Compartir a través de

WorkRestClient class

Constructores

Propiedades

Métodos

Detalles del constructor

WorkRestClient(IVssRestClientOptions)

Parámetros

Detalles de las propiedades

RESOURCE_AREA_ID

Valor de propiedad

Detalles del método

createPlan(CreatePlan, string)

Parámetros

Devoluciones

deletePlan(string, string)

Parámetros

Devoluciones

deleteTeamIteration(TeamContext, string)

Parámetros

Devoluciones

getBacklog(TeamContext, string)

Parámetros

Devoluciones

getBacklogConfigurations(TeamContext)

Parámetros

Devoluciones

getBacklogLevelWorkItems(TeamContext, string)

Parámetros

Devoluciones

getBacklogs(TeamContext)

Parámetros

Devoluciones

getBoard(TeamContext, string)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

getBoardCardRuleSettings(TeamContext, string)

Parámetros

Devoluciones

getBoardCardSettings(TeamContext, string)

Parámetros

Devoluciones

getBoardChart(TeamContext, string, string)

Parámetros

Devoluciones

getBoardCharts(TeamContext, string)

Parámetros

Devoluciones

getBoardColumns(TeamContext, string)

Parámetros

Devoluciones

getBoardMappingParentItems(TeamContext, string, number[])

Parámetros

Devoluciones

getBoardRows(TeamContext, string)

Parámetros

Devoluciones

getBoards(TeamContext)

Parámetros

Devoluciones

getBoardUserSettings(TeamContext, string)

Parámetros

Devoluciones

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parámetros

Devoluciones

getCapacityWithIdentityRef(TeamContext, string, string)

Parámetros

Devoluciones

getColumns(TeamContext)

Parámetros

Devoluciones

getColumnSuggestedValues(string)

Parámetros