WorkRestClient class

Paket:: azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas: RestClientBase

Konstruktor

Properti

Metode

createPlan(CreatePlan, string)	Menambahkan paket baru untuk tim
deletePlan(string, string)	Menghapus paket yang ditentukan
deleteTeamIteration(TeamContext, string)	Menghapus iterasi tim dengan iterationId
getBacklog(TeamContext, string)	Mendapatkan tingkat backlog
getBacklogConfigurations(TeamContext)	Mendapatkan konfigurasi backlog untuk tim
getBacklogLevelWorkItems(TeamContext, string)	Mendapatkan daftar item kerja dalam tingkat backlog
getBacklogs(TeamContext)	Mencantumkan semua tingkat backlog
getBoard(TeamContext, string)	Dapatkan papan
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	Mendapatkan lencana yang menampilkan status kolom di papan.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	Mendapatkan lencana yang menampilkan status kolom di papan.
getBoardCardRuleSettings(TeamContext, string)	Mendapatkan pengaturan Aturan kartu papan untuk id papan atau papan berdasarkan nama
getBoardCardSettings(TeamContext, string)	Mendapatkan pengaturan kartu papan untuk id papan atau papan berdasarkan nama
getBoardChart(TeamContext, string, string)	Mendapatkan bagan papan
getBoardCharts(TeamContext, string)	Mendapatkan bagan papan
getBoardColumns(TeamContext, string)	Mendapatkan kolom di papan
getBoardMappingParentItems(TeamContext, string, number[])	Mengembalikan daftar model filter bidang induk untuk daftar id workitem yang diberikan
getBoardRows(TeamContext, string)	Mendapatkan baris di papan
getBoards(TeamContext)	Mendapatkan papan
getBoardUserSettings(TeamContext, string)	Mendapatkan pengaturan pengguna papan untuk id papan
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	Mendapatkan kapasitas tim termasuk total kapasitas dan hari libur
getCapacityWithIdentityRef(TeamContext, string, string)	Mendapatkan kapasitas anggota tim
getColumns(TeamContext)
getColumnSuggestedValues(string)	Mendapatkan kolom papan yang tersedia dalam proyek
getDeliveryTimelineData(string, string, number, Date, Date)	Dapatkan Data Tampilan Pengiriman
getIterationWorkItems(TeamContext, string)	Mendapatkan item kerja untuk perulangan
getPlan(string, string)	Mendapatkan informasi untuk paket yang ditentukan
getPlans(string)	Dapatkan informasi untuk semua paket yang dikonfigurasi untuk tim tertentu
getProcessConfiguration(string)	Mendapatkan konfigurasi proses
getRowSuggestedValues(string)	Mendapatkan baris papan yang tersedia dalam proyek
getTeamDaysOff(TeamContext, string)	Dapatkan hari libur tim untuk iterasi
getTeamFieldValues(TeamContext)	Mendapatkan kumpulan nilai bidang tim
getTeamIteration(TeamContext, string)	Mendapatkan iterasi tim dengan iterationId
getTeamIterations(TeamContext, string)	Mendapatkan iterasi tim menggunakan filter jangka waktu
getTeamSettings(TeamContext)	Mendapatkan pengaturan tim
getTotalIterationCapacities(string, string)	Mendapatkan kapasitas perulangan untuk semua tim dalam iterasi
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	Menambahkan perulangan ke tim
reorderBacklogWorkItems(ReorderOperation, TeamContext)	Menyusun Ulang Item Kerja Backlog/Papan Produk
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	Menyusun ulang Sprint Backlog/Item Kerja Taskboard
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	Mengganti kapasitas tim
setBoardOptions({[key: string]: string}, TeamContext, string)	Opsi perbarui papan
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	Membuat/memperbarui pengaturan aturan otomatisasi
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	Memperbarui pengaturan Aturan kartu papan untuk id papan atau papan berdasarkan nama
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	Memperbarui pengaturan kartu papan untuk id papan atau papan berdasarkan nama
updateBoardChart(BoardChart, TeamContext, string, string)	Memperbarui bagan papan
updateBoardColumns(BoardColumn[], TeamContext, string)	Memperbarui kolom pada papan
updateBoardRows(BoardRow[], TeamContext, string)	Memperbarui baris pada papan
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	Memperbarui pengaturan pengguna papan untuk id papan
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	Memperbarui kapasitas anggota tim
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	Memperbarui informasi untuk paket yang ditentukan
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	Memperbarui pengaturan Aturan kartu taskboard
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	Memperbarui pengaturan kartu papan tugas
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	Mengatur hari libur tim untuk iterasi
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	Memperbarui nilai bidang tim
updateTeamSettings(TeamSettingsPatch, TeamContext)	Memperbarui pengaturan tim
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

Detail Konstruktor

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createPlan(CreatePlan, string)

Menambahkan paket baru untuk tim

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

Parameter

postedPlan: CreatePlan

Definisi rencana

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<Plan>

deletePlan(string, string)

Menghapus paket yang ditentukan

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

Parameter

project: string

ID proyek atau nama proyek

id: string

Pengidentifikasi paket

Mengembalikan

Promise<void>

deleteTeamIteration(TeamContext, string)

Menghapus iterasi tim dengan iterationId

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

id: string

ID perulangan

Mengembalikan

Promise<void>

getBacklog(TeamContext, string)

Mendapatkan tingkat backlog

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

id: string

Id tingkat backlog

Mengembalikan

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

Mendapatkan konfigurasi backlog untuk tim

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

Mendapatkan daftar item kerja dalam tingkat backlog

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

backlogId: string

Mengembalikan

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

Mencantumkan semua tingkat backlog

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

Dapatkan papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

id: string

pengidentifikasi untuk papan, nama tingkat backlog papan (Eg:"Stories") atau Id

Mengembalikan

Promise<Board>

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

Mendapatkan lencana yang menampilkan status kolom di papan.

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

id: string

Id papan.

columnOptions: BoardBadgeColumnOptions

Menentukan kolom apa yang akan ditampilkan.

columns: string[]

Jika columnOptions diatur ke kustom, tentukan daftar nama kolom.

Mengembalikan

Promise<BoardBadge>

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

Mendapatkan lencana yang menampilkan status kolom di papan.

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

id: string

Id papan.

columnOptions: BoardBadgeColumnOptions

Menentukan kolom apa yang akan ditampilkan.

columns: string[]

Jika columnOptions diatur ke kustom, tentukan daftar nama kolom.

Mengembalikan

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

Mendapatkan pengaturan Aturan kartu papan untuk id papan atau papan berdasarkan nama

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Mengembalikan

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

Mendapatkan pengaturan kartu papan untuk id papan atau papan berdasarkan nama

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Mengembalikan

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

Mendapatkan bagan papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Pengidentifikasi untuk papan, nama tingkat backlog papan (Eg:"Stories") atau Id

name: string

Nama bagan

Mengembalikan

Promise<BoardChart>

getBoardCharts(TeamContext, string)

Mendapatkan bagan papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Pengidentifikasi untuk papan, nama tingkat backlog papan (Eg:"Stories") atau Id

Mengembalikan

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

Mendapatkan kolom di papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Nama atau ID papan tertentu

Mengembalikan

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

Mengembalikan daftar model filter bidang induk untuk daftar id workitem yang diberikan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

childBacklogContextCategoryRefName: string

workitemIds: number[]

Mengembalikan

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

Mendapatkan baris di papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Nama atau ID papan tertentu

Mengembalikan

Promise<BoardRow[]>

getBoards(TeamContext)

Mendapatkan papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

Mendapatkan pengaturan pengguna papan untuk id papan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

board: string

ID Papan atau Nama

Mengembalikan

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Mendapatkan kapasitas tim termasuk total kapasitas dan hari libur

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

Mengembalikan

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

Mendapatkan kapasitas anggota tim

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

teamMemberId: string

ID anggota tim

Mengembalikan

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

Mendapatkan kolom papan yang tersedia dalam proyek

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<BoardSuggestedValue[]>

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

Dapatkan Data Tampilan Pengiriman

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

Parameter

project: string

ID proyek atau nama proyek

id: string

Pengidentifikasi untuk tampilan pengiriman

revision: number

Revisi paket yang Anda inginkan datanya. Jika paket saat ini adalah revisi yang berbeda, Anda akan mendapatkan pengecualian ViewRevisionMismatchException. Jika Anda tidak menyediakan revisi, Anda akan mendapatkan data untuk revisi terbaru.

startDate: Date

Tanggal mulai garis waktu

endDate: Date

Tanggal akhir garis waktu

Mengembalikan

Promise<DeliveryViewData>

getIterationWorkItems(TeamContext, string)

Mendapatkan item kerja untuk perulangan

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

Mengembalikan

Promise<IterationWorkItems>

getPlan(string, string)

Mendapatkan informasi untuk paket yang ditentukan

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

Parameter

project: string

ID proyek atau nama proyek

id: string

Pengidentifikasi paket

Mengembalikan

Promise<Plan>

getPlans(string)

Dapatkan informasi untuk semua paket yang dikonfigurasi untuk tim tertentu

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<Plan[]>

getProcessConfiguration(string)

Mendapatkan konfigurasi proses

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

Mendapatkan baris papan yang tersedia dalam proyek

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

Dapatkan hari libur tim untuk iterasi

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

Mengembalikan

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

Mendapatkan kumpulan nilai bidang tim

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

Mendapatkan iterasi tim dengan iterationId

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

id: string

ID perulangan

Mengembalikan

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

Mendapatkan iterasi tim menggunakan filter jangka waktu

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

timeframe: string

Filter yang iterasinya dikembalikan berdasarkan waktu relatif. Hanya Saat Ini yang didukung saat ini.

Mengembalikan

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

Mendapatkan pengaturan tim

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

Mendapatkan kapasitas perulangan untuk semua tim dalam iterasi

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

Parameter

project: string

ID proyek atau nama proyek

iterationId: string

ID perulangan

Mengembalikan

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

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

Parameter

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

Mengembalikan

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

Menambahkan perulangan ke tim

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

Parameter

iteration: TeamSettingsIteration

Iterasi untuk ditambahkan

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

Menyusun Ulang Item Kerja Backlog/Papan Produk

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

Parameter

operation: ReorderOperation

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

Menyusun ulang Sprint Backlog/Item Kerja Taskboard

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

Parameter

operation: ReorderOperation

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

Id perulangan

Mengembalikan

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

Mengganti kapasitas tim

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

Parameter

capacities: TeamMemberCapacityIdentityRef[]

Kapasitas tim untuk mengganti

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

Mengembalikan

Promise<TeamMemberCapacityIdentityRef[]>

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

Opsi perbarui papan

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

Parameter

options: {[key: string]: string}

opsi untuk diperbarui

teamContext: TeamContext

Konteks tim untuk operasi

id: string

pengidentifikasi untuk papan, baik nama jamak kategori (Eg:"Stories") atau guid

Mengembalikan

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

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

Membuat/memperbarui pengaturan aturan otomatisasi

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

Parameter

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

Parameter yang diperlukan untuk membuat/memperbarui pengaturan aturan otomatisasi

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

Memperbarui pengaturan Aturan kartu papan untuk id papan atau papan berdasarkan nama

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

Parameter

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Mengembalikan

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

Memperbarui pengaturan kartu papan untuk id papan atau papan berdasarkan nama

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

Parameter

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Mengembalikan

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

Memperbarui bagan papan

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

Parameter

chart: BoardChart

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Pengidentifikasi untuk papan, nama tingkat backlog papan (Eg:"Stories") atau Id

name: string

Nama bagan

Mengembalikan

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

Memperbarui kolom pada papan

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

Parameter

boardColumns: BoardColumn[]

Daftar kolom papan yang akan diperbarui

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Nama atau ID papan tertentu

Mengembalikan

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

Memperbarui baris pada papan

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

Parameter

boardRows: BoardRow[]

Daftar baris papan yang akan diperbarui

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Nama atau ID papan tertentu

Mengembalikan

Promise<BoardRow[]>

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

Memperbarui pengaturan pengguna papan untuk id papan

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

Parameter

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

Konteks tim untuk operasi

board: string

Mengembalikan

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

Memperbarui kapasitas anggota tim

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

Parameter

patch: CapacityPatch

Kapasitas yang diperbarui

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

teamMemberId: string

ID anggota tim

Mengembalikan

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

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

Parameter

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

Memperbarui informasi untuk paket yang ditentukan

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

Parameter

updatedPlan: UpdatePlan

Rencanakan definisi yang akan diperbarui

project: string

ID proyek atau nama proyek

id: string

Pengidentifikasi paket

Mengembalikan

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

Memperbarui pengaturan Aturan kartu taskboard

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

Parameter

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

Memperbarui pengaturan kartu papan tugas

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

Parameter

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

Mengatur hari libur tim untuk iterasi

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

Parameter

daysOffPatch: TeamSettingsDaysOffPatch

Patch hari libur tim yang berisi daftar tanggal mulai dan berakhir

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

ID perulangan

Mengembalikan

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

Memperbarui nilai bidang tim

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

Parameter

patch: TeamFieldValuesPatch

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

Memperbarui pengaturan tim

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

Parameter

teamSettingsPatch: TeamSettingsPatch

Perubahan TeamSettings

teamContext: TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

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

Parameter

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

Konteks tim untuk operasi

iterationId: string

workItemId: number

Mengembalikan

Promise<void>

Saran dan Komentar

Apakah halaman ini membantu?

Bagikan melalui

WorkRestClient class

Konstruktor

Properti

Metode

Detail Konstruktor

WorkRestClient(IVssRestClientOptions)

Parameter

Detail Properti

RESOURCE_AREA_ID

Nilai Properti

Detail Metode

createPlan(CreatePlan, string)

Parameter

Mengembalikan

deletePlan(string, string)

Parameter

Mengembalikan

deleteTeamIteration(TeamContext, string)

Parameter

Mengembalikan

getBacklog(TeamContext, string)

Parameter

Mengembalikan

getBacklogConfigurations(TeamContext)

Parameter

Mengembalikan

getBacklogLevelWorkItems(TeamContext, string)

Parameter

Mengembalikan

getBacklogs(TeamContext)

Parameter

Mengembalikan

getBoard(TeamContext, string)

Parameter

Mengembalikan

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

Parameter

Mengembalikan

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

Parameter

Mengembalikan

getBoardCardRuleSettings(TeamContext, string)

Parameter

Mengembalikan

getBoardCardSettings(TeamContext, string)

Parameter

Mengembalikan

getBoardChart(TeamContext, string, string)

Parameter

Mengembalikan

getBoardCharts(TeamContext, string)

Parameter

Mengembalikan

getBoardColumns(TeamContext, string)

Parameter

Mengembalikan

getBoardMappingParentItems(TeamContext, string, number[])

Parameter

Mengembalikan

getBoardRows(TeamContext, string)

Parameter

Mengembalikan

getBoards(TeamContext)

Parameter

Mengembalikan

getBoardUserSettings(TeamContext, string)

Parameter

Mengembalikan

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

Parameter

Mengembalikan

getCapacityWithIdentityRef(TeamContext, string, string)

Parameter

Mengembalikan

getColumns(TeamContext)

Parameter

Mengembalikan

getColumnSuggestedValues(string)

Parameter