WorkItemTrackingProcessRestClient class
应使用 (派生自) 的基类向 VSS REST API 发出请求
- Extends
构造函数
Work |
属性
RESOURCE_AREA_ID |
方法
构造函数详细信息
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)
将页面添加到工作项窗体。
function addPage(page: Page, processId: string, witRefName: string): Promise<Page>
参数
- page
- Page
页。
- processId
-
string
进程的 ID。
- witRefName
-
string
工作项类型的引用名称。
返回
Promise<Page>
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)
在组中创建控件。
function createControlInGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>
参数
- control
- Control
控件。
- processId
-
string
进程的 ID。
- witRefName
-
string
工作项类型的引用名称。
- groupId
-
string
要向其添加控件的组的 ID。
返回
Promise<Control>
createList(PickList)
创建选取列表。
function createList(picklist: PickList): Promise<PickList>
参数
- picklist
- PickList
选择列表
返回
Promise<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()
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)
获取进程中工作项类型的已编辑系统控件。 若要获取 (base + 已编辑的所有系统控件,) 请使用布局 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)
汇报列表。
function updateList(picklist: PickList, listId: string): Promise<PickList>
参数
- picklist
- PickList
- listId
-
string
列表的 ID
返回
Promise<PickList>
updatePage(Page, string, string)
在工作项窗体上汇报页面
function updatePage(page: Page, processId: string, witRefName: string): Promise<Page>
参数
- page
- Page
页面
- processId
-
string
进程的 ID
- witRefName
-
string
工作项类型的引用名称
返回
Promise<Page>
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)
在工作项窗体上汇报/添加系统控件。
function updateSystemControl(control: Control, processId: string, witRefName: string, controlId: string): Promise<Control>
参数
- control
- Control
- processId
-
string
进程的 ID。
- witRefName
-
string
工作项类型的引用名称。
- controlId
-
string
控件的 ID。
返回
Promise<Control>
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>