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
프로젝트 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
보드의 식별자, 보드의 백로그 수준 이름(예: "스토리") 또는 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가 사용자 지정으로 설정된 경우 열 이름 목록을 지정합니다.
반환
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가 사용자 지정으로 설정된 경우 열 이름 목록을 지정합니다.
반환
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
상대 시간에 따라 반복이 반환되는 필터입니다. 현재만 지원됩니다.
반환
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
교체할 팀 용량
- 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
업데이트할 보드 열 목록
- 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
- 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>