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)	更新指定進程和工作專案類型範圍內的單一欄位。

建構函式詳細資料

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

進程的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

groupId

string

要加入控制項之群組的識別碼

傳回

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

將欄位加入至進程中的工作專案類型。

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

參數

field

WorkItemTypeFieldModel2

processId

string

進程的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

pageId

string

要新增群組的頁面識別碼

sectionId

string

要新增群組之區段的識別碼

傳回

Promise<Group>

addPage(Page, string, string)

將頁面新增至工作專案表單

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

參數

page

Page

頁面

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

傳回

Promise<Page>

createBehavior(BehaviorCreateModel, string)

在指定的進程中建立單一行為。

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

參數

behavior

BehaviorCreateModel

processId

string

進程的識別碼

傳回

Promise<BehaviorModel>

createField(FieldModel, string)

在程式中建立單一欄位。

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

參數

field

FieldModel

processId

string

進程的識別碼

傳回

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

傳回

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

在程式中建立工作專案類型。

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

參數

workItemType

WorkItemTypeModel

processId

string

進程的識別碼

傳回

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

移除進程中的行為。

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

參數

processId

string

進程的識別碼

behaviorId

string

行為的識別碼

傳回

Promise<void>

deleteList(string)

移除挑選清單。

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

參數

listId

string

清單的識別碼

傳回

Promise<void>

deleteStateDefinition(string, string, string)

移除進程工作專案類型中的狀態定義。

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

參數

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

stateId

string

狀態的識別碼

傳回

Promise<void>

deleteWorkItemType(string, string)

移除進程中的工作專案類型。

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

參數

processId

string

進程的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

groupId

string

群組的識別碼

controlId

string

控制項的識別碼

傳回

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

pageId

string

群組所在的頁面識別碼

sectionId

string

群組所在的區段識別碼

groupId

string

群組的識別碼

傳回

Promise<Group>

editPage(Page, string, string)

更新工作專案表單上的頁面

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

參數

page

Page

頁面

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

傳回

Promise<Page>

getBehavior(string, string)

傳回進程中的單一行為。

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

參數

processId

string

進程的識別碼

behaviorId

string

行為的識別碼

傳回

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

傳回進程工作專案類型的行為。

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

參數

processId

string

進程的識別碼

witRefNameForBehaviors

string

行為的工作專案類型參考名稱

behaviorRefName

string

行為的參考名稱

傳回

Promise<WorkItemTypeBehavior>

getBehaviors(string)

傳回進程中所有行為的清單。

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

參數

processId

string

進程的識別碼

傳回

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

傳回進程工作專案類型的所有行為清單。

function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>

參數

processId

string

進程的識別碼

witRefNameForBehaviors

string

行為的工作專案類型參考名稱

傳回

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

取得表單配置

function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>

參數

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

傳回

Promise<FormLayout>

getList(string)

傳回挑選清單。

function getList(listId: string): Promise<PickListModel>

參數

listId

string

清單的識別碼

傳回

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

stateId

string

狀態的識別碼

傳回

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

傳回進程工作專案類型中所有狀態定義的清單。

function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>

參數

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

傳回

Promise<WorkItemStateResultModel[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

傳回進程的工作專案類型。

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

參數

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

expand

GetWorkItemTypeExpand

傳回

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

傳回進程工作專案類型中的單一欄位。

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

參數

processId

string

進程的識別碼

witRefNameForFields

string

欄位的工作專案類型參考名稱

fieldRefName

string

欄位的參考名稱

傳回

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

傳回進程工作專案類型中所有欄位的清單。

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

參數

processId

string

進程的識別碼

witRefNameForFields

string

欄位的工作專案類型參考名稱

傳回

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

傳回進程中所有工作專案類型的清單。

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

參數

processId

string

進程的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

stateId

string

狀態的識別碼

傳回

Promise<WorkItemStateResultModel>

removeBehaviorFromWorkItemType(string, string, string)

移除進程的工作專案類型行為。

function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>

參數

processId

string

進程的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

groupId

string

群組的識別碼

controlId

string

要移除之控制項的識別碼

傳回

Promise<void>

removeFieldFromWorkItemType(string, string, string)

移除進程工作專案類型中的欄位。

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

參數

processId

string

進程的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

pageId

string

群組所在的頁面識別碼

sectionId

string

群組區段的識別碼位於

groupId

string

群組的識別碼

傳回

Promise<void>

removePage(string, string, string)

從工作專案表單中移除頁面

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

參數

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

pageId

string

頁面的識別碼

傳回

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

取代進程中的行為。

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

參數

behaviorData

BehaviorReplaceModel

processId

string

進程的識別碼

behaviorId

string

行為的識別碼

傳回

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

groupId

string

要將控制項移至之群組的識別碼

controlId

string

控制項的識別碼

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

pageId

string

群組所在的頁面識別碼

sectionId

string

群組所在的區段識別碼

groupId

string

群組的識別碼

removeFromPageId

string

要從中移除群組的頁面識別碼

removeFromSectionId

string

要從中移除群組的區段識別碼

傳回

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

進程的識別碼

witRefName

string

工作專案類型的參考名稱

pageId

string

群組所在的頁面識別碼

sectionId

string

群組所在的區段識別碼

groupId

string

群組的識別碼

removeFromSectionId

string

要從中移除群組的區段識別碼

傳回

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

更新進程行為的預設工作專案類型。

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

參數

behavior

WorkItemTypeBehavior

processId

string

進程的識別碼

witRefNameForBehaviors

string

行為的工作專案類型參考名稱

傳回

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

更新程式中的指定欄位。

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

參數

field

FieldUpdate

processId

string

進程的識別碼

傳回

Promise<FieldModel>

updateList(PickListModel, string)

更新清單。

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

參數

picklist

PickListModel

listId

string

清單的識別碼

傳回

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

更新進程工作專案類型中的指定狀態定義。

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

參數

stateModel

WorkItemStateInputModel

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

stateId

string

狀態的識別碼

傳回

Promise<WorkItemStateResultModel>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

更新進程的工作專案類型。

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

參數

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

進程的識別碼

witRefName

string

工作專案類型的參考名稱

傳回

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

更新指定進程和工作專案類型範圍內的單一欄位。

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

參數

field

WorkItemTypeFieldModel2

用來更新欄位的模型

processId

string

進程的識別碼

witRefNameForFields

string

欄位的工作專案類型參考名稱

傳回

Promise<WorkItemTypeFieldModel2>