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
進程的識別碼
- witRefNameForBehaviors
-
string
行為的工作專案類型參考名稱
傳回
Promise<WorkItemTypeBehavior>
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)
將欄位加入至工作專案類型。
function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>
參數
- processId
-
string
進程的識別碼。
- 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
進程的識別碼。
- 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>
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)
將規則加入至程式中的工作專案類型。
function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>
參數
- processRuleCreate
- CreateProcessRuleRequest
- processId
-
string
進程的識別碼
- 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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- groupId
-
string
要加入控制項之群組的識別碼。
傳回
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
進程的識別碼
傳回
Promise<ProcessBehavior>
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)
在程式中建立工作專案類型。
function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>
參數
- workItemType
- CreateProcessWorkItemTypeRequest
- processId
-
string
要建立工作專案類型的處理常式識別碼。
傳回
Promise<ProcessWorkItemType>
createStateDefinition(WorkItemStateInputModel, string, string)
在進程的工作專案類型中建立狀態定義。
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>
參數
- stateModel
- WorkItemStateInputModel
- processId
-
string
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
傳回
Promise<WorkItemStateResultModel>
deleteList(string)
移除挑選清單。
function deleteList(listId: string): Promise<void>
參數
- listId
-
string
清單的識別碼
傳回
Promise<void>
deleteProcessBehavior(string, string)
移除進程中的行為。
function deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>
參數
- processId
-
string
進程的識別碼
- behaviorRefName
-
string
行為的參考名稱
傳回
Promise<void>
deleteProcessById(string)
移除特定識別碼的程式。
function deleteProcessById(processTypeId: string): Promise<void>
參數
- processTypeId
-
string
傳回
Promise<void>
deleteProcessWorkItemType(string, string)
移除進程中的工作專案類型。
function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>
參數
- processId
-
string
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
傳回
Promise<void>
deleteProcessWorkItemTypeRule(string, string, string)
從程式中的工作專案類型中移除規則。
function deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>
參數
- processId
-
string
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
- ruleId
-
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>
deleteSystemControl(string, string, string)
刪除工作專案表單上的系統控制項修改。
function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>
參數
- processId
-
string
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- controlId
-
string
控制項的識別碼。
傳回
Promise<Control[]>
editProcess(UpdateProcessModel, string)
編輯特定識別碼的程式。
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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
傳回
Promise<ProcessWorkItemTypeField[]>
getBehaviorForWorkItemType(string, string, string)
傳回進程工作專案類型的行為。
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>
參數
- processId
-
string
進程的識別碼
- witRefNameForBehaviors
-
string
行為的工作專案類型參考名稱
- behaviorRefName
-
string
行為的參考名稱
傳回
Promise<WorkItemTypeBehavior>
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<PickList>
參數
- listId
-
string
清單的識別碼
傳回
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
進程的識別碼
- behaviorRefName
-
string
行為的參考名稱
- expand
- GetBehaviorsExpand
傳回
Promise<ProcessBehavior>
getProcessBehaviors(string, GetBehaviorsExpand)
傳回進程中所有行為的清單。
function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>
參數
- processId
-
string
進程的識別碼
- expand
- GetBehaviorsExpand
傳回
Promise<ProcessBehavior[]>
getProcessByItsId(string, GetProcessExpandLevel)
取得指定識別碼的單一進程。
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
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
- expand
- GetWorkItemTypeExpand
旗標,以判斷要傳回的工作專案類型屬性
傳回
Promise<ProcessWorkItemType>
getProcessWorkItemTypeRule(string, string, string)
傳回進程工作專案類型中的單一規則。
function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>
參數
- processId
-
string
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
- ruleId
-
string
規則的識別碼
傳回
Promise<ProcessRule>
getProcessWorkItemTypeRules(string, string)
傳回進程工作專案類型中所有規則的清單。
function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>
參數
- processId
-
string
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
傳回
Promise<ProcessRule[]>
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)
傳回進程中所有工作專案類型的清單。
function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>
參數
- processId
-
string
進程的識別碼
- expand
- GetWorkItemTypeExpand
旗標,以判斷要傳回的工作專案類型屬性
傳回
Promise<ProcessWorkItemType[]>
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[]>
getSystemControls(string, string)
取得進程中工作專案類型的編輯系統控制項。 若要取得基底和編輯的所有系統控制項 (,) 請使用版面配置 API (s)
function getSystemControls(processId: string, witRefName: string): Promise<Control[]>
參數
- processId
-
string
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
傳回
Promise<Control[]>
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)
傳回工作專案類型中的欄位。
function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>
參數
- processId
-
string
進程的識別碼。
- 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
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
- stateId
-
string
狀態的識別碼
傳回
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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- groupId
-
string
要移動控制項之群組的識別碼。
- controlId
-
string
控制項的識別碼。
- removeFromGroupId
-
string
要從中移除控制項的群組識別碼。
傳回
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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- pageId
-
string
群組所在的頁面識別碼。
- sectionId
-
string
群組為 i.n 的區段識別碼
- groupId
-
string
群組的識別碼。
- removeFromPageId
-
string
要從中移除群組的頁面識別碼。
- removeFromSectionId
-
string
要從中移除群組的區段識別碼。
傳回
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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- pageId
-
string
群組所在的頁面識別碼。
- sectionId
-
string
群組所在的區段識別碼。
- groupId
-
string
群組的識別碼。
- removeFromSectionId
-
string
要從中移除群組的區段識別碼。
傳回
Promise<Group>
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>
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>
removeWorkItemTypeField(string, string, string)
從工作專案類型中移除欄位。 不會永久刪除欄位。
function removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>
參數
- processId
-
string
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- fieldRefName
-
string
欄位的參考名稱。
傳回
Promise<void>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
更新進程的工作專案類型行為。
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>
參數
- behavior
- WorkItemTypeBehavior
- processId
-
string
進程的識別碼
- 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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- groupId
-
string
群組的識別碼。
- controlId
-
string
控制項的識別碼。
傳回
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
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- pageId
-
string
群組所在的頁面識別碼。
- sectionId
-
string
群組所在的區段識別碼。
- groupId
-
string
群組的識別碼。
傳回
Promise<Group>
updateList(PickList, string)
更新清單。
function updateList(picklist: PickList, listId: string): Promise<PickList>
參數
- picklist
- PickList
- listId
-
string
清單的識別碼
傳回
Promise<PickList>
updatePage(Page, string, string)
更新工作專案表單上的頁面
function updatePage(page: Page, processId: string, witRefName: string): Promise<Page>
參數
- page
- Page
頁面
- processId
-
string
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
傳回
Promise<Page>
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)
取代進程中的行為。
function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>
參數
- behaviorData
- ProcessBehaviorUpdateRequest
- processId
-
string
進程的識別碼
- behaviorRefName
-
string
行為的參考名稱
傳回
Promise<ProcessBehavior>
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)
更新進程的工作專案類型。
function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>
參數
- workItemTypeUpdate
- UpdateProcessWorkItemTypeRequest
- processId
-
string
進程的識別碼
- 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
進程的識別碼
- witRefName
-
string
工作專案類型的參考名稱
- ruleId
-
string
規則的識別碼
傳回
Promise<ProcessRule>
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>
updateSystemControl(Control, string, string, string)
更新/新增工作專案表單上的系統控制項。
function updateSystemControl(control: Control, processId: string, witRefName: string, controlId: string): Promise<Control>
參數
- control
- Control
- processId
-
string
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- controlId
-
string
控制項的識別碼。
傳回
Promise<Control>
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)
更新工作專案類型的欄位。
function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>
參數
- processId
-
string
進程的識別碼。
- witRefName
-
string
工作專案類型的參考名稱。
- fieldRefName
-
string
欄位的參考名稱。
傳回
Promise<ProcessWorkItemTypeField>