WorkItemTrackingProcessDefinitionsRestClient class

패키지:

azure-devops-extension-api

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends

RestClientBase

생성자

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

속성

RESOURCE_AREA_ID

메서드

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	프로세스의 작업 항목 유형에 동작을 추가합니다.
addControlToGroup(Control, string, string, string)	그룹에 컨트롤을 만듭니다.
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	프로세스의 작업 항목 형식에 필드를 추가합니다.
addGroup(Group, string, string, string, string)	작업 항목 양식에 그룹 추가
addPage(Page, string, string)	작업 항목 양식에 페이지 추가
createBehavior(BehaviorCreateModel, string)	지정된 프로세스에서 단일 동작을 만듭니다.
createField(FieldModel, string)	프로세스에서 단일 필드를 만듭니다.
createList(PickListModel)	선택 목록을 만듭니다.
createStateDefinition(WorkItemStateInputModel, string, string)	프로세스의 작업 항목 형식에 상태 정의를 만듭니다.
createWorkItemType(WorkItemTypeModel, string)	프로세스에서 작업 항목 형식을 만듭니다.
deleteBehavior(string, string)	프로세스에서 동작을 제거합니다.
deleteList(string)	선택 목록을 제거합니다.
deleteStateDefinition(string, string, string)	프로세스의 작업 항목 형식에서 상태 정의를 제거합니다.
deleteWorkItemType(string, string)	프로세스에서 작업 항목 유형을 제거합니다.
editControl(Control, string, string, string, string)	작업 항목 양식에 컨트롤 업데이트
editGroup(Group, string, string, string, string, string)	작업 항목 양식에서 그룹 업데이트
editPage(Page, string, string)	작업 항목 양식의 페이지 업데이트
getBehavior(string, string)	프로세스에서 단일 동작을 반환합니다.
getBehaviorForWorkItemType(string, string, string)	프로세스의 작업 항목 유형에 대한 동작을 반환합니다.
getBehaviors(string)	프로세스의 모든 동작 목록을 반환합니다.
getBehaviorsForWorkItemType(string, string)	프로세스의 작업 항목 유형에 대한 모든 동작 목록을 반환합니다.
getFormLayout(string, string)	양식 레이아웃을 가져옵니다.
getList(string)	선택 목록을 반환합니다.
getListsMetadata()	선택 목록의 메타 데이터를 반환합니다.
getStateDefinition(string, string, string)	프로세스의 작업 항목 형식에서 상태 정의를 반환합니다.
getStateDefinitions(string, string)	프로세스의 작업 항목 유형에 있는 모든 상태 정의 목록을 반환합니다.
getWorkItemType(string, string, GetWorkItemTypeExpand)	프로세스의 작업 항목 유형을 반환합니다.
getWorkItemTypeField(string, string, string)	프로세스의 작업 항목 형식에 있는 단일 필드를 반환합니다.
getWorkItemTypeFields(string, string)	프로세스의 작업 항목 형식에 있는 모든 필드 목록을 반환합니다.
getWorkItemTypes(string, GetWorkItemTypeExpand)	프로세스의 모든 작업 항목 형식 목록을 반환합니다.
hideStateDefinition(HideStateModel, string, string, string)	프로세스의 작업 항목 형식에서 상태 정의를 숨깁니다.
removeBehaviorFromWorkItemType(string, string, string)	프로세스의 작업 항목 유형에 대한 동작을 제거합니다.
removeControlFromGroup(string, string, string, string)	작업 항목 양식에서 컨트롤을 제거합니다.
removeFieldFromWorkItemType(string, string, string)	프로세스의 작업 항목 형식에서 필드를 제거합니다.
removeGroup(string, string, string, string, string)	작업 항목 양식에서 그룹을 제거합니다.
removePage(string, string, string)	작업 항목 양식에서 페이지를 제거합니다.
replaceBehavior(BehaviorReplaceModel, string, string)	프로세스의 동작을 바꿉니다.
setControlInGroup(Control, string, string, string, string, string)	컨트롤을 새 그룹으로 이동
setGroupInPage(Group, string, string, string, string, string, string, string)	그룹을 다른 페이지 및 섹션으로 이동
setGroupInSection(Group, string, string, string, string, string, string)	그룹을 다른 섹션으로 이동
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	프로세스의 동작에 대한 기본 작업 항목 형식을 업데이트.
updateField(FieldUpdate, string)	프로세스에서 지정된 필드를 업데이트.
updateList(PickListModel, string)	목록을 업데이트.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	프로세스의 작업 항목 형식에서 지정된 상태 정의를 업데이트.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	프로세스의 작업 항목 형식을 업데이트.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	지정된 프로세스 및 작업 항목 유형의 scope 단일 필드를 업데이트.

생성자 세부 정보

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(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>

addControlToGroup(Control, string, string, string)

그룹에 컨트롤을 만듭니다.

function addControlToGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>

매개 변수

control

Control

컨트롤

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

groupId

string

컨트롤을 추가할 그룹의 ID입니다.

반환

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

프로세스의 작업 항목 형식에 필드를 추가합니다.

function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

매개 변수

field

WorkItemTypeFieldModel2

processId

string

프로세스의 ID

witRefNameForFields

string

필드의 작업 항목 형식 참조 이름

반환

Promise<WorkItemTypeFieldModel2>

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)

작업 항목 양식에 페이지 추가

function addPage(page: Page, processId: string, witRefName: string): Promise<Page>

매개 변수

page

Page

페이지

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

반환

Promise<Page>

createBehavior(BehaviorCreateModel, string)

지정된 프로세스에서 단일 동작을 만듭니다.

function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>

매개 변수

behavior

BehaviorCreateModel

processId

string

프로세스의 ID

반환

Promise<BehaviorModel>

createField(FieldModel, string)

프로세스에서 단일 필드를 만듭니다.

function createField(field: FieldModel, processId: string): Promise<FieldModel>

매개 변수

field

FieldModel

processId

string

프로세스의 ID

반환

Promise<FieldModel>

createList(PickListModel)

선택 목록을 만듭니다.

function createList(picklist: PickListModel): Promise<PickListModel>

매개 변수

picklist

PickListModel

반환

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

프로세스의 작업 항목 형식에 상태 정의를 만듭니다.

function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>

매개 변수

stateModel

WorkItemStateInputModel

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

반환

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

프로세스에서 작업 항목 형식을 만듭니다.

function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>

매개 변수

workItemType

WorkItemTypeModel

processId

string

프로세스의 ID

반환

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

프로세스에서 동작을 제거합니다.

function deleteBehavior(processId: string, behaviorId: string): Promise<void>

매개 변수

processId

string

프로세스의 ID

behaviorId

string

동작의 ID

반환

Promise<void>

deleteList(string)

선택 목록을 제거합니다.

function deleteList(listId: string): Promise<void>

매개 변수

listId

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>

deleteWorkItemType(string, string)

프로세스에서 작업 항목 유형을 제거합니다.

function deleteWorkItemType(processId: string, witRefName: string): Promise<void>

매개 변수

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

반환

Promise<void>

editControl(Control, string, string, string, string)

작업 항목 양식에 컨트롤 업데이트

function editControl(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>

editGroup(Group, string, string, string, string, string)

작업 항목 양식에서 그룹 업데이트

function editGroup(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>

editPage(Page, string, string)

작업 항목 양식의 페이지 업데이트

function editPage(page: Page, processId: string, witRefName: string): Promise<Page>

매개 변수

page

Page

페이지

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

반환

Promise<Page>

getBehavior(string, string)

프로세스에서 단일 동작을 반환합니다.

function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>

매개 변수

processId

string

프로세스의 ID

behaviorId

string

동작의 ID

반환

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

프로세스의 작업 항목 유형에 대한 동작을 반환합니다.

function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>

매개 변수

processId

string

프로세스의 ID

witRefNameForBehaviors

string

동작에 대한 작업 항목 유형 참조 이름

behaviorRefName

string

동작의 참조 이름

반환

Promise<WorkItemTypeBehavior>

getBehaviors(string)

프로세스의 모든 동작 목록을 반환합니다.

function getBehaviors(processId: string): Promise<BehaviorModel[]>

매개 변수

processId

string

프로세스의 ID

반환

Promise<BehaviorModel[]>

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<PickListModel>

매개 변수

listId

string

목록의 ID

반환

Promise<PickListModel>

getListsMetadata()

선택 목록의 메타 데이터를 반환합니다.

function getListsMetadata(): Promise<PickListMetadataModel[]>

반환

Promise<PickListMetadataModel[]>

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[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

프로세스의 작업 항목 유형을 반환합니다.

function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>

매개 변수

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

expand

GetWorkItemTypeExpand

반환

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

프로세스의 작업 항목 형식에 있는 단일 필드를 반환합니다.

function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>

매개 변수

processId

string

프로세스의 ID

witRefNameForFields

string

필드의 작업 항목 형식 참조 이름

fieldRefName

string

필드의 참조 이름

반환

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

프로세스의 작업 항목 형식에 있는 모든 필드 목록을 반환합니다.

function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>

매개 변수

processId

string

프로세스의 ID

witRefNameForFields

string

필드의 작업 항목 형식 참조 이름

반환

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

프로세스의 모든 작업 항목 형식 목록을 반환합니다.

function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>

매개 변수

processId

string

프로세스의 ID

expand

GetWorkItemTypeExpand

반환

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

프로세스의 작업 항목 형식에서 상태 정의를 숨깁니다.

function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

매개 변수

hideStateModel

HideStateModel

processId

string

프로세스의 ID

witRefName

string

작업 항목 유형의 참조 이름

stateId

string

상태의 ID입니다.

반환

Promise<WorkItemStateResultModel>

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>

removeFieldFromWorkItemType(string, string, string)

프로세스의 작업 항목 형식에서 필드를 제거합니다.

function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>

매개 변수

processId

string

프로세스의 ID

witRefNameForFields

string

필드의 작업 항목 형식 참조 이름

fieldRefName

string

필드의 참조 이름

반환

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>

replaceBehavior(BehaviorReplaceModel, string, string)

프로세스의 동작을 바꿉니다.

function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>

매개 변수

behaviorData

BehaviorReplaceModel

processId

string

프로세스의 ID

behaviorId

string

동작의 ID

반환

Promise<BehaviorModel>

setControlInGroup(Control, string, string, string, string, string)

컨트롤을 새 그룹으로 이동

function setControlInGroup(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

컨트롤을 제거할 그룹

반환

Promise<Control>

setGroupInPage(Group, string, string, string, string, string, string, string)

그룹을 다른 페이지 및 섹션으로 이동

function setGroupInPage(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

그룹이 있는 섹션의 ID

groupId

string

그룹의 ID

removeFromPageId

string

그룹을 제거할 페이지의 ID

removeFromSectionId

string

그룹을 제거할 섹션의 ID

반환

Promise<Group>

setGroupInSection(Group, string, string, string, string, string, string)

그룹을 다른 섹션으로 이동

function setGroupInSection(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>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

프로세스의 동작에 대한 기본 작업 항목 형식을 업데이트.

function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>

매개 변수

behavior

WorkItemTypeBehavior

processId

string

프로세스의 ID

witRefNameForBehaviors

string

동작에 대한 작업 항목 형식 참조 이름

반환

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

프로세스에서 지정된 필드를 업데이트.

function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>

매개 변수

field

FieldUpdate

processId

string

프로세스의 ID

반환

Promise<FieldModel>

updateList(PickListModel, string)

목록을 업데이트.

function updateList(picklist: PickListModel, listId: string): Promise<PickListModel>

매개 변수

picklist

PickListModel

listId

string

목록의 ID

반환

Promise<PickListModel>

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>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

프로세스의 작업 항목 형식을 업데이트.

function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>

매개 변수

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

프로세스의 ID

witRefName

string

작업 항목 형식의 참조 이름입니다.

반환

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

지정된 프로세스 및 작업 항목 유형의 scope 단일 필드를 업데이트.

function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

매개 변수

field

WorkItemTypeFieldModel2

필드를 업데이트할 모델

processId

string

프로세스의 ID

witRefNameForFields

string

필드의 작업 항목 형식 참조 이름

반환

Promise<WorkItemTypeFieldModel2>