WorkRestClient class

Ссылка

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends: RestClientBase

Конструкторы

WorkRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

createPlan(CreatePlan, string)	Добавление нового плана для команды
deletePlan(string, string)	Удаление указанного плана
deleteTeamIteration(TeamContext, string)	Удаление итерации команды по идентификатору итерации
getBacklog(TeamContext, string)	Получение уровня невыполненной работы
getBacklogConfigurations(TeamContext)	Возвращает конфигурацию невыполненной работы для команды.
getBacklogLevelWorkItems(TeamContext, string)	Получение списка рабочих элементов на уровне невыполненной работы
getBacklogs(TeamContext)	Список всех уровней невыполненной работы
getBoard(TeamContext, string)	Получение доски
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Возвращает эмблему, отображающую состояние столбцов на доске.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Возвращает эмблему, отображающую состояние столбцов на доске.
getBoardCardRuleSettings(TeamContext, string)	Получение карта параметров правила для идентификатора доски или доски по имени
getBoardCardSettings(TeamContext, string)	Получение параметров карта доски для идентификатора платы или доски по имени
getBoardChart(TeamContext, string, string)	Получение диаграммы досок
getBoardCharts(TeamContext, string)	Получение диаграмм досок
getBoardColumns(TeamContext, string)	Получение столбцов на доске
getBoardMappingParentItems(TeamContext, string, number[])	Возвращает список родительской модели фильтра полей для заданного списка идентификаторов рабочих элементов.
getBoardRows(TeamContext, string)	Получение строк на доске
getBoards(TeamContext)	Получение досок
getBoardUserSettings(TeamContext, string)	Получение параметров пользователя доски для идентификатора доски
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Получение емкости команды, включая общую емкость и выходные дни
getCapacityWithIdentityRef(TeamContext, string, string)	Получение емкости участника команды
getColumns(TeamContext)
getColumnSuggestedValues(string)	Получение доступных столбцов доски в проекте
getDeliveryTimelineData(string, string, number, Date, Date)	Получение данных представления доставки
getIterationWorkItems(TeamContext, string)	Получение рабочих элементов для итерации
getPlan(string, string)	Получение сведений для указанного плана
getPlans(string)	Получение сведений обо всех планах, настроенных для данной команды
getProcessConfiguration(string)	Получение конфигурации процесса
getRowSuggestedValues(string)	Получение доступных строк доски в проекте
getTeamDaysOff(TeamContext, string)	Получение выходных дней команды для итерации
getTeamFieldValues(TeamContext)	Получение коллекции значений полей команды
getTeamIteration(TeamContext, string)	Получение итерации команды по идентификатору итерации
getTeamIterations(TeamContext, string)	Получение итераций команды с помощью фильтра временных интервалов
getTeamSettings(TeamContext)	Получение параметров команды
getTotalIterationCapacities(string, string)	Получение емкости итерации для всех команд в итерации
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Добавление итерации в команду
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Изменение порядка невыполненной работы по продукту/доски рабочих элементов
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Изменение порядка рабочих элементов невыполненной работы и панели задач
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Замена емкости команды
setBoardOptions({[key: string]: string}, TeamContext, string)	Параметры доски обновления
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Создает или обновляет параметры правил автоматизации
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Обновление карта параметров правил для идентификатора платы или доски по имени
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Обновление параметров карта платы для идентификатора платы или доски по имени
updateBoardChart(BoardChart, TeamContext, string, string)	Обновление диаграммы с досками
updateBoardColumns(BoardColumn[], TeamContext, string)	Обновление столбцов на доске
updateBoardRows(BoardRow[], TeamContext, string)	Обновление строк на доске
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Обновление параметров пользователя платы для идентификатора платы
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Обновление емкости участника команды
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Обновление сведений для указанного плана
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Обновление параметров правила карта панели задач
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Обновление параметров карта панели задач
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Настройка выходных дней команды для итерации
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Обновление значений полей команды
updateTeamSettings(TeamSettingsPatch, TeamContext)	Обновление параметров команды
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Сведения о конструкторе

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

createPlan(CreatePlan, string)

Добавление нового плана для команды

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

Параметры

postedPlan: CreatePlan

Определение плана

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<Plan>

deletePlan(string, string)

Удаление указанного плана

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

Параметры

project: string

Идентификатор проекта или имя проекта

id: string

Идентификатор плана

Возвращаемое значение

Promise<void>

deleteTeamIteration(TeamContext, string)

Удаление итерации команды по идентификатору итерации

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

Параметры

teamContext: TeamContext

Контекст команды для операции

id: string

Идентификатор итерации

Возвращаемое значение

Promise<void>

getBacklog(TeamContext, string)

Получение уровня невыполненной работы

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

Параметры

teamContext: TeamContext

Контекст команды для операции

id: string

Идентификатор уровня невыполненной работы

Возвращаемое значение

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Возвращает конфигурацию невыполненной работы для команды.

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

Параметры

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Получение списка рабочих элементов на уровне невыполненной работы

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

Параметры

teamContext: TeamContext

Контекст команды для операции

backlogId: string

Возвращаемое значение

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Список всех уровней невыполненной работы

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

Параметры

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Получение доски

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

Параметры

teamContext: TeamContext

Контекст команды для операции

id: string

идентификатор для доски, имя уровня невыполненной работы доски (например, "Истории") или идентификатор

Возвращаемое значение

Promise<Board>

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

Возвращает эмблему, отображающую состояние столбцов на доске.

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

Параметры

teamContext: TeamContext

Контекст команды для операции

id: string

Идентификатор доски.

columnOptions: BoardBadgeColumnOptions

Определяет, какие столбцы должны отображаться.

columns: string[]

Если параметр columnOptions имеет значение custom, укажите список имен столбцов.

Возвращаемое значение

Promise<BoardBadge>

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

Возвращает эмблему, отображающую состояние столбцов на доске.

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

Параметры

teamContext: TeamContext

Контекст команды для операции

id: string

Идентификатор доски.

columnOptions: BoardBadgeColumnOptions

Определяет, какие столбцы должны отображаться.

columns: string[]

Если параметр columnOptions имеет значение custom, укажите список имен столбцов.

Возвращаемое значение

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Получение карта параметров правила для идентификатора доски или доски по имени

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Возвращаемое значение

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Получение параметров карта доски для идентификатора платы или доски по имени

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Возвращаемое значение

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Получение диаграммы досок

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Идентификатор для доски, имя уровня невыполненной работы доски (например, "Истории") или идентификатор

name: string

Имя диаграммы

Возвращаемое значение

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Получение диаграмм досок

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Идентификатор для доски, имя уровня невыполненной работы доски (например, "Истории") или идентификатор

Возвращаемое значение

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Получение столбцов на доске

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Имя или идентификатор определенной платы

Возвращаемое значение

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Возвращает список родительской модели фильтра полей для заданного списка идентификаторов рабочих элементов.

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

Параметры

teamContext: TeamContext

Контекст команды для операции

childBacklogContextCategoryRefName: string

workitemIds: number[]

Возвращаемое значение

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Получение строк на доске

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Имя или идентификатор определенной платы

Возвращаемое значение

Promise<BoardRow[]>

getBoards(TeamContext)

Получение досок

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

Параметры

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Получение параметров пользователя доски для идентификатора доски

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

Параметры

teamContext: TeamContext

Контекст команды для операции

board: string

Идентификатор или имя платы

Возвращаемое значение

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Получение емкости команды, включая общую емкость и выходные дни

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

Параметры

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Получение емкости участника команды

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

Параметры

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

teamMemberId: string

Идентификатор участника команды

Возвращаемое значение

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Параметры

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Получение доступных столбцов доски в проекте

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BoardSuggestedValue[]>

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

Получение данных представления доставки

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

Параметры

project: string

Идентификатор проекта или имя проекта

id: string

Идентификатор для представления доставки

revision: number

Пересмотр плана, для которого нужны данные. Если текущий план является другой редакцией, вы получите исключение ViewRevisionMismatchException. Если вы не предоставите редакцию, вы получите данные для последней редакции.

startDate: Date

Дата начала временная шкала

endDate: Date

Дата окончания временная шкала

Возвращаемое значение

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Получение рабочих элементов для итерации

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

Параметры

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<IterationWorkItems>

getPlan(string, string)

Получение сведений для указанного плана

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

Параметры

project: string

Идентификатор проекта или имя проекта

id: string

Идентификатор плана

Возвращаемое значение

Promise<Plan>

getPlans(string)

Получение сведений обо всех планах, настроенных для данной команды

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<Plan[]>

getProcessConfiguration(string)

Получение конфигурации процесса

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Получение доступных строк доски в проекте

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Получение выходных дней команды для итерации

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

Параметры

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Получение коллекции значений полей команды

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

Параметры

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Получение итерации команды по идентификатору итерации

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

Параметры

teamContext: TeamContext

Контекст команды для операции

id: string

Идентификатор итерации

Возвращаемое значение

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Получение итераций команды с помощью фильтра временных интервалов

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

Параметры

teamContext: TeamContext

Контекст команды для операции

timeframe: string

Фильтр, для которого возвращаются итерации на основе относительного времени. В настоящее время поддерживается только текущая версия.

Возвращаемое значение

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Получение параметров команды

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

Параметры

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Получение емкости итерации для всех команд в итерации

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

Параметры

project: string

Идентификатор или имя проекта

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Параметры

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Возвращаемое значение

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Добавление итерации в команду

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

Параметры

iteration: TeamSettingsIteration

Добавляемая итерация

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Изменение порядка невыполненной работы по продукту/доски рабочих элементов

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

Параметры

operation: ReorderOperation

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Изменение порядка рабочих элементов невыполненной работы и панели задач

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

Параметры

operation: ReorderOperation

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Замена емкости команды

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

Параметры

capacities: TeamMemberCapacityIdentityRef[]

Емкость команды для замены

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<TeamMemberCapacityIdentityRef[]>

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

Параметры доски обновления

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

Параметры

options: {[key: string]: string}

параметры для обновления

teamContext: TeamContext

Контекст команды для операции

id: string

идентификатор для доски: имя категории во множественном числе (например, "Истории") или guid

Возвращаемое значение

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Создает или обновляет параметры правил автоматизации

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

Параметры

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Обязательные параметры для создания или обновления параметров правил автоматизации

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Обновление карта параметров правил для идентификатора платы или доски по имени

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

Параметры

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Контекст команды для операции

board: string

Возвращаемое значение

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Обновление параметров карта платы для идентификатора платы или доски по имени

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

Параметры

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Контекст команды для операции

board: string

Возвращаемое значение

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Обновление диаграммы с досками

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

Параметры

chart: BoardChart

teamContext: TeamContext

Контекст команды для операции

board: string

Идентификатор для доски: имя уровня невыполненной работы доски (например, "Истории") или идентификатор

name: string

Имя диаграммы

Возвращаемое значение

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Обновление столбцов на доске

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

Параметры

boardColumns: BoardColumn[]

Список столбцов доски для обновления

teamContext: TeamContext

Контекст команды для операции

board: string

Имя или идентификатор определенной платы

Возвращаемое значение

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Обновление строк на доске

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

Параметры

boardRows: BoardRow[]

Список строк доски для обновления

teamContext: TeamContext

Контекст команды для операции

board: string

Имя или идентификатор определенной платы

Возвращаемое значение

Promise<BoardRow[]>

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

Обновление параметров пользователя платы для идентификатора платы

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

Параметры

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Контекст команды для операции

board: string

Возвращаемое значение

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Обновление емкости участника команды

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

Параметры

patch: CapacityPatch

Обновленная емкость

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

teamMemberId: string

Идентификатор участника команды

Возвращаемое значение

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Параметры

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Обновление сведений для указанного плана

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

Параметры

updatedPlan: UpdatePlan

Определение плана для обновления

project: string

Идентификатор или имя проекта

id: string

Идентификатор плана

Возвращаемое значение

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Обновление параметров правила карта панели задач

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

Параметры

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Обновление параметров карта панели задач

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

Параметры

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Настройка выходных дней команды для итерации

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

Параметры

daysOffPatch: TeamSettingsDaysOffPatch

Исправление выходных дней команды, содержащее список дат начала и окончания

teamContext: TeamContext

Контекст команды для операции

iterationId: string

Идентификатор итерации

Возвращаемое значение

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Обновление значений полей команды

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

Параметры

patch: TeamFieldValuesPatch

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Обновление параметров команды

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

Параметры

teamSettingsPatch: TeamSettingsPatch

Изменения TeamSettings

teamContext: TeamContext

Контекст команды для операции

Возвращаемое значение

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Параметры

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Контекст команды для операции

iterationId: string

workItemId: number

Возвращаемое значение

Promise<void>

Поделиться через

WorkRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

WorkRestClient(IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

createPlan(CreatePlan, string)

Параметры

Возвращаемое значение

deletePlan(string, string)

Параметры

Возвращаемое значение

deleteTeamIteration(TeamContext, string)

Параметры

Возвращаемое значение

getBacklog(TeamContext, string)

Параметры

Возвращаемое значение

getBacklogConfigurations(TeamContext)

Параметры

Возвращаемое значение

getBacklogLevelWorkItems(TeamContext, string)

Параметры

Возвращаемое значение

getBacklogs(TeamContext)

Параметры

Возвращаемое значение

getBoard(TeamContext, string)

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

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

Параметры

Возвращаемое значение

getBoardCardRuleSettings(TeamContext, string)

Параметры

Возвращаемое значение

getBoardCardSettings(TeamContext, string)

Параметры

Возвращаемое значение

getBoardChart(TeamContext, string, string)

Параметры

Возвращаемое значение

getBoardCharts(TeamContext, string)

Параметры

Возвращаемое значение

getBoardColumns(TeamContext, string)

Параметры

Возвращаемое значение

getBoardMappingParentItems(TeamContext, string, number[])

Параметры

Возвращаемое значение

getBoardRows(TeamContext, string)

Параметры

Возвращаемое значение

getBoards(TeamContext)

Параметры

Возвращаемое значение

getBoardUserSettings(TeamContext, string)

Параметры

Возвращаемое значение

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Параметры

Возвращаемое значение

getCapacityWithIdentityRef(TeamContext, string, string)

Параметры

Возвращаемое значение

getColumns(TeamContext)

Параметры

Возвращаемое значение

getColumnSuggestedValues(string)

Параметры