WorkItemTrackingProcessRestClient class
Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS
- Extends
Konstruktory
| Work |
Vlastnosti
| RESOURCE_AREA_ID |
Metody
Podrobnosti konstruktoru
WorkItemTrackingProcessRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)Parametry
- options
- IVssRestClientOptions
Podrobnosti vlastnosti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringHodnota vlastnosti
string
Podrobnosti metody
addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Přidá chování k typu pracovní položky procesu.
function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Parametry
- behavior
- WorkItemTypeBehavior
- processId
-
string
ID procesu
- witRefNameForBehaviors
-
string
Referenční název typu pracovní položky pro chování
Návraty
Promise<WorkItemTypeBehavior>
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)
Přidá pole k typu pracovní položky.
function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
Návraty
Promise<ProcessWorkItemTypeField>
addGroup(Group, string, string, string, string)
Přidá skupinu do formuláře pracovní položky.
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>Parametry
- group
- Group
Skupina.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- pageId
-
string
ID stránky, do které chcete skupinu přidat.
- sectionId
-
string
ID oddílu, do které se má skupina přidat.
Návraty
Promise<Group>
addPage(Page, string, string)
Přidá stránku do formuláře pracovní položky.
function addPage(page: Page, processId: string, witRefName: string): Promise<Page>Parametry
- page
- Page
Stránka.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
Návraty
Promise<Page>
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)
Přidá pravidlo k typu pracovní položky v procesu.
function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>Parametry
- processRuleCreate
- CreateProcessRuleRequest
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<ProcessRule>
createControlInGroup(Control, string, string, string)
Vytvoří ovládací prvek ve skupině.
function createControlInGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>Parametry
- control
- Control
Ovládací prvek.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- groupId
-
string
ID skupiny, do které se má ovládací prvek přidat.
Návraty
Promise<Control>
createList(PickList)
Vytvoří rozevírací seznam.
function createList(picklist: PickList): Promise<PickList>Parametry
- picklist
- PickList
Picklist
Návraty
Promise<PickList>
createNewProcess(CreateProcessModel)
Vytvoří proces.
function createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>Parametry
- createRequest
- CreateProcessModel
CreateProcessModel.
Návraty
Promise<ProcessInfo>
createProcessBehavior(ProcessBehaviorCreateRequest, string)
Vytvoří jediné chování v daném procesu.
function createProcessBehavior(behavior: ProcessBehaviorCreateRequest, processId: string): Promise<ProcessBehavior>Parametry
- behavior
- ProcessBehaviorCreateRequest
- processId
-
string
ID procesu
Návraty
Promise<ProcessBehavior>
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)
Vytvoří v procesu typ pracovní položky.
function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>Parametry
- workItemType
- CreateProcessWorkItemTypeRequest
- processId
-
string
ID procesu, na kterém chcete vytvořit typ pracovní položky.
Návraty
Promise<ProcessWorkItemType>
createStateDefinition(WorkItemStateInputModel, string, string)
Vytvoří definici stavu v typu pracovní položky procesu.
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>Parametry
- stateModel
- WorkItemStateInputModel
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<WorkItemStateResultModel>
deleteList(string)
Odebere rozevírací seznam.
function deleteList(listId: string): Promise<void>Parametry
- listId
-
string
ID seznamu
Návraty
Promise<void>
deleteProcessBehavior(string, string)
Odebere chování v procesu.
function deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>Parametry
- processId
-
string
ID procesu
- behaviorRefName
-
string
Název odkazu chování
Návraty
Promise<void>
deleteProcessById(string)
Odebere proces konkrétního ID.
function deleteProcessById(processTypeId: string): Promise<void>Parametry
- processTypeId
-
string
Návraty
Promise<void>
deleteProcessWorkItemType(string, string)
Odebere typ pracovní položky v procesu.
function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
Návraty
Promise<void>
deleteProcessWorkItemTypeRule(string, string, string)
Odebere pravidlo z typu pracovní položky v procesu.
function deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- ruleId
-
string
ID pravidla
Návraty
Promise<void>
deleteStateDefinition(string, string, string)
Odebere definici stavu v typu pracovní položky procesu.
function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- stateId
-
string
ID stavu
Návraty
Promise<void>
deleteSystemControl(string, string, string)
Odstraní úpravu systémového ovládacího prvku ve formuláři pracovní položky.
function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- controlId
-
string
ID ovládacího prvku.
Návraty
Promise<Control[]>
editProcess(UpdateProcessModel, string)
Upravte proces konkrétního ID.
function editProcess(updateRequest: UpdateProcessModel, processTypeId: string): Promise<ProcessInfo>Parametry
- updateRequest
- UpdateProcessModel
- processTypeId
-
string
Návraty
Promise<ProcessInfo>
getAllWorkItemTypeFields(string, string)
Vrátí seznam všech polí v typu pracovní položky.
function getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<ProcessWorkItemTypeField[]>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
Návraty
Promise<ProcessWorkItemTypeField[]>
getBehaviorForWorkItemType(string, string, string)
Vrátí chování pro typ pracovní položky procesu.
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>Parametry
- processId
-
string
ID procesu
- witRefNameForBehaviors
-
string
Referenční název typu pracovní položky pro chování
- behaviorRefName
-
string
Název odkazu chování
Návraty
Promise<WorkItemTypeBehavior>
getBehaviorsForWorkItemType(string, string)
Vrátí seznam všech chování pro typ pracovní položky procesu.
function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>Parametry
- processId
-
string
ID procesu
- witRefNameForBehaviors
-
string
Referenční název typu pracovní položky pro chování
Návraty
Promise<WorkItemTypeBehavior[]>
getFormLayout(string, string)
Získá rozložení formuláře.
function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
Návraty
Promise<FormLayout>
getList(string)
Vrátí rozevírací seznam.
function getList(listId: string): Promise<PickList>Parametry
- listId
-
string
ID seznamu
Návraty
Promise<PickList>
getListOfProcesses(GetProcessExpandLevel)
Získejte seznam všech procesů včetně systémových a zděděných.
function getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>Parametry
- expand
- GetProcessExpandLevel
Návraty
Promise<ProcessInfo[]>
getListsMetadata()
Vrátí metadata rozevíracího seznamu.
function getListsMetadata(): Promise<PickListMetadata[]>Návraty
Promise<PickListMetadata[]>
getProcessBehavior(string, string, GetBehaviorsExpand)
Vrátí chování procesu.
function getProcessBehavior(processId: string, behaviorRefName: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior>Parametry
- processId
-
string
ID procesu
- behaviorRefName
-
string
Název odkazu chování
- expand
- GetBehaviorsExpand
Návraty
Promise<ProcessBehavior>
getProcessBehaviors(string, GetBehaviorsExpand)
Vrátí seznam všech chování v procesu.
function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>Parametry
- processId
-
string
ID procesu
- expand
- GetBehaviorsExpand
Návraty
Promise<ProcessBehavior[]>
getProcessByItsId(string, GetProcessExpandLevel)
Získá jeden proces zadaného ID.
function getProcessByItsId(processTypeId: string, expand?: GetProcessExpandLevel): Promise<ProcessInfo>Parametry
- processTypeId
-
string
- expand
- GetProcessExpandLevel
Návraty
Promise<ProcessInfo>
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)
Vrátí jeden typ pracovní položky v procesu.
function getProcessWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- expand
- GetWorkItemTypeExpand
Příznak určující, jaké vlastnosti typu pracovní položky se mají vrátit
Návraty
Promise<ProcessWorkItemType>
getProcessWorkItemTypeRule(string, string, string)
Vrátí jedno pravidlo v typu pracovní položky procesu.
function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- ruleId
-
string
ID pravidla
Návraty
Promise<ProcessRule>
getProcessWorkItemTypeRules(string, string)
Vrátí seznam všech pravidel v typu pracovní položky procesu.
function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<ProcessRule[]>
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)
Vrátí seznam všech typů pracovních položek v procesu.
function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>Parametry
- processId
-
string
ID procesu
- expand
- GetWorkItemTypeExpand
Příznak určující, jaké vlastnosti typu pracovní položky se mají vrátit
Návraty
Promise<ProcessWorkItemType[]>
getStateDefinition(string, string, string)
Vrátí definici jednoho stavu v typu pracovní položky procesu.
function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- stateId
-
string
ID stavu
Návraty
Promise<WorkItemStateResultModel>
getStateDefinitions(string, string)
Vrátí seznam všech definic stavu v typu pracovní položky procesu.
function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<WorkItemStateResultModel[]>
getSystemControls(string, string)
Získá editované systémové ovládací prvky pro typ pracovní položky v procesu. Pokud chcete získat všechny systémové ovládací prvky (základní + upravené), použijte rozhraní API rozložení.
function getSystemControls(processId: string, witRefName: string): Promise<Control[]>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
Návraty
Promise<Control[]>
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)
Vrátí pole typu pracovní položky.
function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- fieldRefName
-
string
Název odkazu pole.
Návraty
Promise<ProcessWorkItemTypeField>
hideStateDefinition(HideStateModel, string, string, string)
Skryje definici stavu v typu pracovní položky procesu. Skryty můžou být jenom stavy s customizationType:System.
function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Parametry
- hideStateModel
- HideStateModel
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- stateId
-
string
ID stavu
Návraty
Promise<WorkItemStateResultModel>
moveControlToGroup(Control, string, string, string, string, string)
Přesune ovládací prvek do zadané skupiny.
function moveControlToGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>Parametry
- control
- Control
Ovládací prvek.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- groupId
-
string
ID skupiny, do které se má ovládací prvek přesunout.
- controlId
-
string
ID ovládacího prvku.
- removeFromGroupId
-
string
ID skupiny, ze které se má ovládací prvek odebrat.
Návraty
Promise<Control>
moveGroupToPage(Group, string, string, string, string, string, string, string)
Přesune skupinu na jinou stránku a oddíl.
function moveGroupToPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>Parametry
- group
- Group
Aktualizovaná skupina.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- pageId
-
string
ID stránky, na které se skupina nachází.
- sectionId
-
string
ID oddílu, ve které skupina je i.n
- groupId
-
string
ID skupiny.
- removeFromPageId
-
string
ID stránky, ze které chcete skupinu odebrat.
- removeFromSectionId
-
string
ID oddílu, ze které se má skupina odebrat.
Návraty
Promise<Group>
moveGroupToSection(Group, string, string, string, string, string, string)
Přesune skupinu do jiného oddílu.
function moveGroupToSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>Parametry
- group
- Group
Aktualizovaná skupina.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- pageId
-
string
ID stránky, na které se skupina nachází.
- sectionId
-
string
ID oddílu, ve které se skupina nachází.
- groupId
-
string
ID skupiny.
- removeFromSectionId
-
string
ID oddílu, ze které se má skupina odebrat.
Návraty
Promise<Group>
removeBehaviorFromWorkItemType(string, string, string)
Odebere chování pro typ pracovní položky procesu.
function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>Parametry
- processId
-
string
ID procesu
- witRefNameForBehaviors
-
string
Referenční název typu pracovní položky pro chování
- behaviorRefName
-
string
Název odkazu chování
Návraty
Promise<void>
removeControlFromGroup(string, string, string, string)
Odebere ovládací prvek z formuláře pracovní položky.
function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- groupId
-
string
ID skupiny.
- controlId
-
string
ID ovládacího prvku, který chcete odebrat.
Návraty
Promise<void>
removeGroup(string, string, string, string, string)
Odebere skupinu z formuláře pracovní položky.
function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- pageId
-
string
ID stránky, na které se skupina nachází
- sectionId
-
string
ID oddílu skupiny se nachází v
- groupId
-
string
ID skupiny
Návraty
Promise<void>
removePage(string, string, string)
Odebere stránku z formuláře pracovní položky.
function removePage(processId: string, witRefName: string, pageId: string): Promise<void>Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- pageId
-
string
ID stránky
Návraty
Promise<void>
removeWorkItemTypeField(string, string, string)
Odebere pole z typu pracovní položky. Neodstraní pole trvale.
function removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- fieldRefName
-
string
Název odkazu pole.
Návraty
Promise<void>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Aktualizace chování pro typ pracovní položky procesu.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Parametry
- behavior
- WorkItemTypeBehavior
- processId
-
string
ID procesu
- witRefNameForBehaviors
-
string
Referenční název typu pracovní položky pro chování
Návraty
Promise<WorkItemTypeBehavior>
updateControl(Control, string, string, string, string)
Aktualizace ovládací prvek ve formuláři pracovní položky.
function updateControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>Parametry
- control
- Control
Aktualizovaný ovládací prvek.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- groupId
-
string
ID skupiny.
- controlId
-
string
ID ovládacího prvku.
Návraty
Promise<Control>
updateGroup(Group, string, string, string, string, string)
Aktualizace skupinu ve formuláři pracovní položky.
function updateGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>Parametry
- group
- Group
Aktualizovaná skupina.
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- pageId
-
string
ID stránky, na které se skupina nachází.
- sectionId
-
string
ID oddílu, ve které se skupina nachází.
- groupId
-
string
ID skupiny.
Návraty
Promise<Group>
updateList(PickList, string)
Aktualizace seznamu.
function updateList(picklist: PickList, listId: string): Promise<PickList>Parametry
- picklist
- PickList
- listId
-
string
ID seznamu
Návraty
Promise<PickList>
updatePage(Page, string, string)
Aktualizace stránky ve formuláři pracovní položky
function updatePage(page: Page, processId: string, witRefName: string): Promise<Page>Parametry
- page
- Page
Stránka
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<Page>
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)
Nahradí chování v procesu.
function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>Parametry
- behaviorData
- ProcessBehaviorUpdateRequest
- processId
-
string
ID procesu
- behaviorRefName
-
string
Referenční název chování
Návraty
Promise<ProcessBehavior>
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)
Aktualizace typ pracovní položky procesu.
function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>Parametry
- workItemTypeUpdate
- UpdateProcessWorkItemTypeRequest
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<ProcessWorkItemType>
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)
Aktualizace pravidlo v typu pracovní položky procesu.
function updateProcessWorkItemTypeRule(processRule: UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>Parametry
- processRule
- UpdateProcessRuleRequest
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- ruleId
-
string
ID pravidla
Návraty
Promise<ProcessRule>
updateStateDefinition(WorkItemStateInputModel, string, string, string)
Aktualizace definici daného stavu v typu pracovní položky procesu.
function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Parametry
- stateModel
- WorkItemStateInputModel
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- stateId
-
string
ID stavu
Návraty
Promise<WorkItemStateResultModel>
updateSystemControl(Control, string, string, string)
Aktualizace/přidá do formuláře pracovní položky systémový ovládací prvek.
function updateSystemControl(control: Control, processId: string, witRefName: string, controlId: string): Promise<Control>Parametry
- control
- Control
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- controlId
-
string
ID ovládacího prvku.
Návraty
Promise<Control>
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)
Aktualizace pole v typu pracovní položky.
function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>Parametry
- processId
-
string
ID procesu.
- witRefName
-
string
Název odkazu typu pracovní položky.
- fieldRefName
-
string
Referenční název pole.
Návraty
Promise<ProcessWorkItemTypeField>