WorkRestClient class

パッケージ:

azure-devops-extension-api

VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス

Extends

RestClientBase

コンストラクター

WorkRestClient(IVssRestClientOptions)

プロパティ

RESOURCE_AREA_ID

メソッド

createPlan(CreatePlan, string)	チームの新しいプランを追加する
deletePlan(string, string)	指定したプランを削除する
deleteTeamIteration(TeamContext, string)	iterationId を使用してチームのイテレーションを削除する
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)	ボード ID またはボードのボード カードルール設定を名前で取得する
getBoardCardSettings(TeamContext, string)	ボード ID またはボードのボード カード設定を名前で取得する
getBoardChart(TeamContext, string, string)	ボード チャートを取得する
getBoardCharts(TeamContext, string)	ボード グラフを取得する
getBoardColumns(TeamContext, string)	ボード上の列を取得する
getBoardMappingParentItems(TeamContext, string, number[])	作業項目 ID の指定されたリストの親フィールド フィルター モデルの一覧を返します
getBoardRows(TeamContext, string)	ボード上の行を取得する
getBoards(TeamContext)	ボードを取得する
getBoardUserSettings(TeamContext, string)	ボード ID のボード ユーザー設定を取得する
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)	iterationId でチームのイテレーションを取得する
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)	ボード ID またはボードのボード カードルール設定を名前で更新する
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	ボード ID またはボードのボード カード設定を名前で更新する
updateBoardChart(BoardChart, TeamContext, string, string)	ボード グラフを更新する
updateBoardColumns(BoardColumn[], TeamContext, string)	ボード上の列を更新する
updateBoardRows(BoardRow[], TeamContext, string)	ボード上の行を更新する
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	ボード ID のボード ユーザー設定を更新する
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

プロジェクト ID またはプロジェクト名

戻り値

Promise<Plan>

deletePlan(string, string)

指定したプランを削除する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

id

string

プランの識別子

戻り値

Promise<void>

deleteTeamIteration(TeamContext, string)

iterationId を使用してチームのイテレーションを削除する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

id

string

イテレーションの ID

戻り値

Promise<void>

getBacklog(TeamContext, string)

バックログ レベルを取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

id

string

バックログ レベルの ID

戻り値

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

ボードの識別子。ボードのバックログ レベル名 (例:"Stories") または Id

戻り値

Promise<Board>

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

ボード上の列の状態を表示するバッジを取得します。

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

id

string

ボードの ID。

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

ボードの ID。

columnOptions

BoardBadgeColumnOptions

表示する列を指定します。

columns

string[]

columnOptions が custom に設定されている場合は、列名の一覧を指定します。

戻り値

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

ボード ID またはボードのボード カードルール設定を名前で取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

board

string

戻り値

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

ボード ID またはボードのボード カード設定を名前で取得する

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

ボードの識別子。ボードのバックログ レベル名 (例:"ストーリー") または ID

name

string

グラフ名

戻り値

Promise<BoardChart>

getBoardCharts(TeamContext, string)

ボード グラフを取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

board

string

ボードの識別子。ボードのバックログ レベル名 (例:"ストーリー") または ID

戻り値

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

ボード上の列を取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

board

string

特定のボードの名前または ID

戻り値

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

作業項目 ID の指定されたリストの親フィールド フィルター モデルの一覧を返します

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

特定のボードの名前または ID

戻り値

Promise<BoardRow[]>

getBoards(TeamContext)

ボードを取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

戻り値

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

ボード ID のボード ユーザー設定を取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

board

string

ボード ID または名前

戻り値

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

合計容量と休暇日を含むチームの容量を取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

iterationId

string

イテレーションの ID

戻り値

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

チーム メンバーの容量を取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

iterationId

string

イテレーションの ID

teamMemberId

string

チーム メンバーの ID

戻り値

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

戻り値

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

プロジェクトで使用可能なボード列を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

戻り値

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 またはプロジェクト名

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

イテレーションの ID

戻り値

Promise<IterationWorkItems>

getPlan(string, string)

指定したプランの情報を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

id

string

プランの識別子

戻り値

Promise<Plan>

getPlans(string)

特定のチーム用に構成されたすべてのプランの情報を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<Plan[]>

getProcessConfiguration(string)

プロセス構成を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

プロジェクトで使用可能なボード行を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

イテレーションのためにチームの休みを取得する

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

パラメーター

teamContext

TeamContext

操作のチーム コンテキスト

iterationId

string

イテレーションの ID

戻り値

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

イテレーションの ID

戻り値

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

プロジェクト ID またはプロジェクト名

iterationId

string

イテレーションの ID

戻り値

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

イテレーションの ID

戻り値

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

チームの容量を置き換える

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

パラメーター

capacities

TeamMemberCapacityIdentityRef[]

置き換えるチーム容量

teamContext

TeamContext

操作のチーム コンテキスト

iterationId

string

イテレーションの ID

戻り値

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)

ボード ID またはボードのボード カードルール設定を名前で更新する

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

パラメーター

boardCardRuleSettings

BoardCardRuleSettings

teamContext

TeamContext

操作のチーム コンテキスト

board

string

戻り値

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

ボード ID またはボードのボード カード設定を名前で更新する

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

ボードの識別子。ボードのバックログ レベル名 (例: "ストーリー") または ID

name

string

グラフ名

戻り値

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

ボード上の列を更新する

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

パラメーター

boardColumns

BoardColumn[]

更新するボード列の一覧

teamContext

TeamContext

操作のチーム コンテキスト

board

string

特定のボードの名前または ID

戻り値

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

ボード上の行を更新する

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

パラメーター

boardRows

BoardRow[]

更新するボード行の一覧

teamContext

TeamContext

操作のチーム コンテキスト

board

string

特定のボードの名前または ID

戻り値

Promise<BoardRow[]>

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

ボード ID のボード ユーザー設定を更新する

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

イテレーションの ID

teamMemberId

string

チーム メンバーの ID

戻り値

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 またはプロジェクト名

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

イテレーションの ID

戻り値

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>