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

进程的 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)

汇报给定流程和工作项类型范围内的单个字段。

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

参数

field

WorkItemTypeFieldModel2

用于更新字段的模型

processId

string

进程的 ID

witRefNameForFields

string

字段的工作项类型引用名称

返回

Promise<WorkItemTypeFieldModel2>