WorkRestClient class
應該使用 (衍生自) 的基類,向 VSS REST API 提出要求
- Extends
建構函式
Work |
屬性
RESOURCE_AREA_ID |
方法
建構函式詳細資料
WorkRestClient(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)
依 iterationId 刪除小組的反復專案
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
面板的識別碼,面板的待辦專案層級名稱 (Eg:「Storys」) 或識別碼
傳回
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 設定為自訂,請指定資料行名稱的清單。
傳回
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 設定為自訂,請指定資料行名稱的清單。
傳回
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
面板的識別碼,面板的待辦專案層級名稱 (Eg:「Storys」) 或識別碼
- name
-
string
圖表名稱
傳回
Promise<BoardChart>
getBoardCharts(TeamContext, string)
取得面板圖表
function getBoardCharts(teamContext: TeamContext, board: string): Promise<BoardChartReference[]>
參數
- teamContext
- TeamContext
作業的小組內容
- board
-
string
面板的識別碼,面板的待辦專案層級名稱 (Eg:「Storys」) 或識別碼
傳回
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)
依 iterationId 取得小組的反復專案
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
根據相對時間傳回反復專案的篩選。 目前僅支援 Current。
傳回
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
要取代的小組容量
- 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
面板的識別碼,類別複數名稱 (Eg:「Storys」) 或 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
面板的識別碼,面板的待辦專案層級名稱 (Eg:「Storys」) 或識別碼
- name
-
string
圖表名稱
傳回
Promise<BoardChart>
updateBoardColumns(BoardColumn[], TeamContext, string)
更新面板上的資料行
function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>
參數
- boardColumns
要更新的面板資料行清單
- 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
- 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>