WorkItemTrackingProcessRestClient class
VSS REST api에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
메서드
생성자 세부 정보
WorkItemTrackingProcessRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)매개 변수
- options
- IVssRestClientOptions
속성 세부 정보
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string속성 값
string
메서드 세부 정보
addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
프로세스의 작업 항목 유형에 동작을 추가합니다.
function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>매개 변수
- behavior
- WorkItemTypeBehavior
- processId
-
string
프로세스의 ID
- witRefNameForBehaviors
-
string
동작에 대한 작업 항목 형식 참조 이름
반환
Promise<WorkItemTypeBehavior>
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)
작업 항목 형식에 필드를 추가합니다.
function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<ProcessWorkItemTypeField>
addGroup(Group, string, string, string, string)
작업 항목 양식에 그룹을 추가합니다.
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>매개 변수
- group
- Group
그룹입니다.
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- pageId
-
string
그룹을 추가할 페이지의 ID입니다.
- sectionId
-
string
그룹을 추가할 섹션의 ID입니다.
반환
Promise<Group>
addPage(Page, string, string)
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)
프로세스의 작업 항목 형식에 규칙을 추가합니다.
function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>매개 변수
- processRuleCreate
- CreateProcessRuleRequest
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<ProcessRule>
createControlInGroup(Control, string, string, string)
createList(PickList)
createNewProcess(CreateProcessModel)
프로세스를 만듭니다.
function createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>매개 변수
- createRequest
- CreateProcessModel
CreateProcessModel.
반환
Promise<ProcessInfo>
createProcessBehavior(ProcessBehaviorCreateRequest, string)
지정된 프로세스에서 단일 동작을 만듭니다.
function createProcessBehavior(behavior: ProcessBehaviorCreateRequest, processId: string): Promise<ProcessBehavior>매개 변수
- behavior
- ProcessBehaviorCreateRequest
- processId
-
string
프로세스의 ID
반환
Promise<ProcessBehavior>
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)
프로세스에서 작업 항목 형식을 만듭니다.
function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>매개 변수
- workItemType
- CreateProcessWorkItemTypeRequest
- processId
-
string
작업 항목 유형을 만들 프로세스의 ID입니다.
반환
Promise<ProcessWorkItemType>
createStateDefinition(WorkItemStateInputModel, string, string)
프로세스의 작업 항목 형식에 상태 정의를 만듭니다.
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>매개 변수
- stateModel
- WorkItemStateInputModel
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<WorkItemStateResultModel>
deleteList(string)
선택 목록을 제거합니다.
function deleteList(listId: string): Promise<void>매개 변수
- listId
-
string
목록의 ID
반환
Promise<void>
deleteProcessBehavior(string, string)
프로세스에서 동작을 제거합니다.
function deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID
- behaviorRefName
-
string
동작의 참조 이름입니다.
반환
Promise<void>
deleteProcessById(string)
특정 ID의 프로세스를 제거합니다.
function deleteProcessById(processTypeId: string): Promise<void>매개 변수
- processTypeId
-
string
반환
Promise<void>
deleteProcessWorkItemType(string, string)
프로세스에서 작업 항목 형식을 제거합니다.
function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<void>
deleteProcessWorkItemTypeRule(string, string, string)
프로세스의 작업 항목 형식에서 규칙을 제거합니다.
function deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- ruleId
-
string
규칙의 ID
반환
Promise<void>
deleteStateDefinition(string, string, string)
프로세스의 작업 항목 형식에서 상태 정의를 제거합니다.
function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- stateId
-
string
상태의 ID
반환
Promise<void>
deleteSystemControl(string, string, string)
작업 항목 양식에서 시스템 컨트롤 수정을 삭제합니다.
function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- controlId
-
string
컨트롤의 ID입니다.
반환
Promise<Control[]>
editProcess(UpdateProcessModel, string)
특정 ID의 프로세스를 편집합니다.
function editProcess(updateRequest: UpdateProcessModel, processTypeId: string): Promise<ProcessInfo>매개 변수
- updateRequest
- UpdateProcessModel
- processTypeId
-
string
반환
Promise<ProcessInfo>
getAllWorkItemTypeFields(string, string)
작업 항목 형식의 모든 필드 목록을 반환합니다.
function getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<ProcessWorkItemTypeField[]>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<ProcessWorkItemTypeField[]>
getBehaviorForWorkItemType(string, string, string)
프로세스의 작업 항목 형식에 대한 동작을 반환합니다.
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>매개 변수
- processId
-
string
프로세스의 ID
- witRefNameForBehaviors
-
string
동작에 대한 작업 항목 형식 참조 이름
- behaviorRefName
-
string
동작의 참조 이름입니다.
반환
Promise<WorkItemTypeBehavior>
getBehaviorsForWorkItemType(string, string)
프로세스의 작업 항목 유형에 대한 모든 동작 목록을 반환합니다.
function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>매개 변수
- processId
-
string
프로세스의 ID
- witRefNameForBehaviors
-
string
동작에 대한 작업 항목 형식 참조 이름
반환
Promise<WorkItemTypeBehavior[]>
getFormLayout(string, string)
양식 레이아웃을 가져옵니다.
function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<FormLayout>
getList(string)
선택 목록을 반환합니다.
function getList(listId: string): Promise<PickList>매개 변수
- listId
-
string
목록의 ID
반환
Promise<PickList>
getListOfProcesses(GetProcessExpandLevel)
시스템 및 상속을 포함한 모든 프로세스 목록을 가져옵니다.
function getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>매개 변수
- expand
- GetProcessExpandLevel
반환
Promise<ProcessInfo[]>
getListsMetadata()
선택 목록의 메타 데이터를 반환합니다.
function getListsMetadata(): Promise<PickListMetadata[]>반환
Promise<PickListMetadata[]>
getProcessBehavior(string, string, GetBehaviorsExpand)
프로세스의 동작을 반환합니다.
function getProcessBehavior(processId: string, behaviorRefName: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior>매개 변수
- processId
-
string
프로세스의 ID
- behaviorRefName
-
string
동작의 참조 이름입니다.
- expand
- GetBehaviorsExpand
반환
Promise<ProcessBehavior>
getProcessBehaviors(string, GetBehaviorsExpand)
프로세스의 모든 동작 목록을 반환합니다.
function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>매개 변수
- processId
-
string
프로세스의 ID
- expand
- GetBehaviorsExpand
반환
Promise<ProcessBehavior[]>
getProcessByItsId(string, GetProcessExpandLevel)
지정된 ID의 단일 프로세스를 가져옵니다.
function getProcessByItsId(processTypeId: string, expand?: GetProcessExpandLevel): Promise<ProcessInfo>매개 변수
- processTypeId
-
string
- expand
- GetProcessExpandLevel
반환
Promise<ProcessInfo>
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)
프로세스에서 단일 작업 항목 형식을 반환합니다.
function getProcessWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- expand
- GetWorkItemTypeExpand
반환할 작업 항목 유형의 속성을 결정하는 플래그
반환
Promise<ProcessWorkItemType>
getProcessWorkItemTypeRule(string, string, string)
프로세스의 작업 항목 형식에서 단일 규칙을 반환합니다.
function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- ruleId
-
string
규칙의 ID
반환
Promise<ProcessRule>
getProcessWorkItemTypeRules(string, string)
프로세스의 작업 항목 형식에 있는 모든 규칙 목록을 반환합니다.
function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<ProcessRule[]>
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)
프로세스의 모든 작업 항목 형식 목록을 반환합니다.
function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>매개 변수
- processId
-
string
프로세스의 ID
- expand
- GetWorkItemTypeExpand
반환할 작업 항목 유형의 속성을 결정하는 플래그
반환
Promise<ProcessWorkItemType[]>
getStateDefinition(string, string, string)
프로세스의 작업 항목 형식에서 단일 상태 정의를 반환합니다.
function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- stateId
-
string
상태의 ID입니다.
반환
Promise<WorkItemStateResultModel>
getStateDefinitions(string, string)
프로세스의 작업 항목 형식에 있는 모든 상태 정의 목록을 반환합니다.
function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<WorkItemStateResultModel[]>
getSystemControls(string, string)
프로세스의 작업 항목 유형에 대한 편집된 시스템 컨트롤을 가져옵니다. 모든 시스템 컨트롤(기본 + 편집)을 얻으려면 레이아웃 API를 사용합니다.
function getSystemControls(processId: string, witRefName: string): Promise<Control[]>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<Control[]>
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)
작업 항목 형식의 필드를 반환합니다.
function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- fieldRefName
-
string
필드의 참조 이름입니다.
반환
Promise<ProcessWorkItemTypeField>
hideStateDefinition(HideStateModel, string, string, string)
프로세스의 작업 항목 형식에서 상태 정의를 숨깁니다. customizationType:System이 있는 상태만 숨길 수 있습니다.
function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>매개 변수
- hideStateModel
- HideStateModel
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- stateId
-
string
상태의 ID입니다.
반환
Promise<WorkItemStateResultModel>
moveControlToGroup(Control, string, string, string, string, string)
컨트롤을 지정된 그룹으로 이동합니다.
function moveControlToGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>매개 변수
- control
- Control
컨트롤입니다.
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- groupId
-
string
컨트롤을 이동할 그룹의 ID입니다.
- controlId
-
string
컨트롤의 ID입니다.
- removeFromGroupId
-
string
컨트롤을 제거할 그룹 ID입니다.
반환
Promise<Control>
moveGroupToPage(Group, string, string, string, string, string, string, string)
그룹을 다른 페이지 및 섹션으로 이동합니다.
function moveGroupToPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>매개 변수
- group
- Group
업데이트된 그룹입니다.
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- pageId
-
string
그룹이 있는 페이지의 ID입니다.
- sectionId
-
string
그룹이 i.n인 섹션의 ID입니다.
- groupId
-
string
그룹의 ID입니다.
- removeFromPageId
-
string
그룹을 제거할 페이지의 ID입니다.
- removeFromSectionId
-
string
그룹을 제거할 섹션의 ID입니다.
반환
Promise<Group>
moveGroupToSection(Group, string, string, string, string, string, string)
그룹을 다른 섹션으로 이동합니다.
function moveGroupToSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>매개 변수
- group
- Group
업데이트된 그룹입니다.
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- pageId
-
string
그룹이 있는 페이지의 ID입니다.
- sectionId
-
string
그룹이 있는 섹션의 ID입니다.
- groupId
-
string
그룹의 ID입니다.
- removeFromSectionId
-
string
그룹을 제거할 섹션의 ID입니다.
반환
Promise<Group>
removeBehaviorFromWorkItemType(string, string, string)
프로세스의 작업 항목 유형에 대한 동작을 제거합니다.
function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID
- witRefNameForBehaviors
-
string
동작에 대한 작업 항목 형식 참조 이름
- behaviorRefName
-
string
동작의 참조 이름입니다.
반환
Promise<void>
removeControlFromGroup(string, string, string, string)
작업 항목 양식에서 컨트롤을 제거합니다.
function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- groupId
-
string
그룹의 ID입니다.
- controlId
-
string
제거할 컨트롤의 ID입니다.
반환
Promise<void>
removeGroup(string, string, string, string, string)
작업 항목 양식에서 그룹을 제거합니다.
function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- pageId
-
string
그룹이 있는 페이지의 ID
- sectionId
-
string
그룹에 대한 섹션의 ID는
- groupId
-
string
그룹의 ID입니다.
반환
Promise<void>
removePage(string, string, string)
작업 항목 양식에서 페이지를 제거합니다.
function removePage(processId: string, witRefName: string, pageId: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- pageId
-
string
페이지의 ID입니다.
반환
Promise<void>
removeWorkItemTypeField(string, string, string)
작업 항목 형식에서 필드를 제거합니다. 필드를 영구적으로 삭제하지 않습니다.
function removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- fieldRefName
-
string
필드의 참조 이름입니다.
반환
Promise<void>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
프로세스의 작업 항목 유형에 대한 동작을 업데이트합니다.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>매개 변수
- behavior
- WorkItemTypeBehavior
- processId
-
string
프로세스의 ID
- witRefNameForBehaviors
-
string
동작에 대한 작업 항목 형식 참조 이름
반환
Promise<WorkItemTypeBehavior>
updateControl(Control, string, string, string, string)
작업 항목 양식의 컨트롤을 업데이트합니다.
function updateControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>매개 변수
- control
- Control
업데이트된 컨트롤입니다.
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- groupId
-
string
그룹의 ID입니다.
- controlId
-
string
컨트롤의 ID입니다.
반환
Promise<Control>
updateGroup(Group, string, string, string, string, string)
작업 항목 양식에서 그룹을 업데이트합니다.
function updateGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>매개 변수
- group
- Group
업데이트된 그룹입니다.
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- pageId
-
string
그룹이 있는 페이지의 ID입니다.
- sectionId
-
string
그룹이 있는 섹션의 ID입니다.
- groupId
-
string
그룹의 ID입니다.
반환
Promise<Group>
updateList(PickList, string)
updatePage(Page, string, string)
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)
프로세스의 동작을 바꿉니다.
function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>매개 변수
- behaviorData
- ProcessBehaviorUpdateRequest
- processId
-
string
프로세스의 ID
- behaviorRefName
-
string
동작의 참조 이름입니다.
반환
Promise<ProcessBehavior>
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)
프로세스의 작업 항목 유형을 업데이트합니다.
function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>매개 변수
- workItemTypeUpdate
- UpdateProcessWorkItemTypeRequest
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
반환
Promise<ProcessWorkItemType>
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)
프로세스의 작업 항목 형식에서 규칙을 업데이트합니다.
function updateProcessWorkItemTypeRule(processRule: UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>매개 변수
- processRule
- UpdateProcessRuleRequest
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- ruleId
-
string
규칙의 ID
반환
Promise<ProcessRule>
updateStateDefinition(WorkItemStateInputModel, string, string, string)
프로세스의 작업 항목 형식에서 지정된 상태 정의를 업데이트합니다.
function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>매개 변수
- stateModel
- WorkItemStateInputModel
- processId
-
string
프로세스의 ID
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- stateId
-
string
상태의 ID
반환
Promise<WorkItemStateResultModel>
updateSystemControl(Control, string, string, string)
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)
작업 항목 형식의 필드를 업데이트합니다.
function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>매개 변수
- processId
-
string
프로세스의 ID입니다.
- witRefName
-
string
작업 항목 형식의 참조 이름입니다.
- fieldRefName
-
string
필드의 참조 이름입니다.
반환
Promise<ProcessWorkItemTypeField>