WorkItemTrackingProcessDefinitionsRestClient 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
add |
Přidá chování k typu pracovní položky procesu. |
add |
Vytvoří ovládací prvek ve skupině. |
add |
Přidá pole k typu pracovní položky v procesu. |
add |
Přidá skupinu do formuláře pracovní položky. |
add |
Přidá stránku do formuláře pracovní položky. |
create |
Vytvoří v daném procesu jediné chování. |
create |
Vytvoří v procesu jedno pole. |
create |
Vytvoří rozevírací seznam. |
create |
Vytvoří definici stavu v typu pracovní položky procesu. |
create |
Vytvoří typ pracovní položky v procesu. |
delete |
Odebere chování v procesu. |
delete |
Odebere rozevírací seznam. |
delete |
Odebere definici stavu v typu pracovní položky procesu. |
delete |
Odebere typ pracovní položky v procesu. |
edit |
Aktualizace ovládací prvek ve formuláři pracovní položky |
edit |
Aktualizace skupiny ve formuláři pracovní položky |
edit |
Aktualizace stránku ve formuláři pracovní položky |
get |
Vrátí jedno chování v procesu. |
get |
Vrátí chování pro typ pracovní položky procesu. |
get |
Vrátí seznam všech chování v procesu. |
get |
Vrátí seznam všech chování pro typ pracovní položky procesu. |
get |
Získá rozložení formuláře. |
get |
Vrátí rozevírací seznam. |
get |
Vrátí metadata rozevíracího seznamu. |
get |
Vrátí definici stavu v typu pracovní položky procesu. |
get |
Vrátí seznam všech definic stavu v typu pracovní položky procesu. |
get |
Vrátí typ pracovní položky procesu. |
get |
Vrátí jedno pole v typu pracovní položky procesu. |
get |
Vrátí seznam všech polí v typu pracovní položky procesu. |
get |
Vrátí seznam všech typů pracovních položek v procesu. |
hide |
Skryje definici stavu v typu pracovní položky procesu. |
remove |
Odebere chování pro typ pracovní položky procesu. |
remove |
Odebere ovládací prvek z formuláře pracovní položky. |
remove |
Odebere pole v typu pracovní položky procesu. |
remove |
Odebere skupinu z formuláře pracovní položky. |
remove |
Odebere stránku z formuláře pracovní položky. |
replace |
Nahradí chování v procesu. |
set |
Přesune ovládací prvek do nové skupiny. |
set |
Přesune skupinu na jinou stránku a oddíl. |
set |
Přesune skupinu do jiného oddílu. |
update |
Aktualizace výchozí typ pracovní položky pro chování procesu. |
update |
Aktualizace dané pole v procesu. |
update |
Aktualizace seznamu. |
update |
Aktualizace definici daného stavu v typu pracovní položky procesu. |
update |
Aktualizace typ pracovní položky procesu. |
update |
Aktualizace jedno pole v oboru daného procesu a typu pracovní položky. |
Podrobnosti konstruktoru
WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)
Parametry
- options
- IVssRestClientOptions
Podrobnosti vlastnosti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
Hodnota 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>
addControlToGroup(Control, string, string, string)
Vytvoří ovládací prvek ve skupině.
function addControlToGroup(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>
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)
Přidá pole k typu pracovní položky v procesu.
function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>
Parametry
- field
- WorkItemTypeFieldModel2
- processId
-
string
ID procesu
- witRefNameForFields
-
string
Referenční název typu pracovní položky pro pole
Návraty
Promise<WorkItemTypeFieldModel2>
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, na kterou chcete přidat skupinu
- sectionId
-
string
ID oddílu, do který chcete skupinu 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>
createBehavior(BehaviorCreateModel, string)
Vytvoří v daném procesu jediné chování.
function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>
Parametry
- behavior
- BehaviorCreateModel
- processId
-
string
ID procesu
Návraty
Promise<BehaviorModel>
createField(FieldModel, string)
Vytvoří v procesu jedno pole.
function createField(field: FieldModel, processId: string): Promise<FieldModel>
Parametry
- field
- FieldModel
- processId
-
string
ID procesu
Návraty
Promise<FieldModel>
createList(PickListModel)
Vytvoří rozevírací seznam.
function createList(picklist: PickListModel): Promise<PickListModel>
Parametry
- picklist
- PickListModel
Návraty
Promise<PickListModel>
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>
createWorkItemType(WorkItemTypeModel, string)
Vytvoří typ pracovní položky v procesu.
function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>
Parametry
- workItemType
- WorkItemTypeModel
- processId
-
string
ID procesu
Návraty
Promise<WorkItemTypeModel>
deleteBehavior(string, string)
Odebere chování v procesu.
function deleteBehavior(processId: string, behaviorId: string): Promise<void>
Parametry
- processId
-
string
ID procesu
- behaviorId
-
string
ID chování
Návraty
Promise<void>
deleteList(string)
Odebere rozevírací seznam.
function deleteList(listId: string): Promise<void>
Parametry
- listId
-
string
ID seznamu
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>
deleteWorkItemType(string, string)
Odebere typ pracovní položky v procesu.
function deleteWorkItemType(processId: string, witRefName: string): Promise<void>
Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<void>
editControl(Control, string, string, string, string)
Aktualizace ovládací prvek ve formuláři pracovní položky
function editControl(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>
editGroup(Group, string, string, string, string, string)
Aktualizace skupiny ve formuláři pracovní položky
function editGroup(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>
editPage(Page, string, string)
Aktualizace stránku ve formuláři pracovní položky
function editPage(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>
getBehavior(string, string)
Vrátí jedno chování v procesu.
function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>
Parametry
- processId
-
string
ID procesu
- behaviorId
-
string
ID chování
Návraty
Promise<BehaviorModel>
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
Referenční název chování
Návraty
Promise<WorkItemTypeBehavior>
getBehaviors(string)
Vrátí seznam všech chování v procesu.
function getBehaviors(processId: string): Promise<BehaviorModel[]>
Parametry
- processId
-
string
ID procesu
Návraty
Promise<BehaviorModel[]>
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<PickListModel>
Parametry
- listId
-
string
ID seznamu
Návraty
Promise<PickListModel>
getListsMetadata()
Vrátí metadata rozevíracího seznamu.
function getListsMetadata(): Promise<PickListMetadataModel[]>
Návraty
Promise<PickListMetadataModel[]>
getStateDefinition(string, string, string)
Vrátí definici 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[]>
getWorkItemType(string, string, GetWorkItemTypeExpand)
Vrátí typ pracovní položky procesu.
function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>
Parametry
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
- expand
- GetWorkItemTypeExpand
Návraty
Promise<WorkItemTypeModel>
getWorkItemTypeField(string, string, string)
Vrátí jedno pole v typu pracovní položky procesu.
function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>
Parametry
- processId
-
string
ID procesu
- witRefNameForFields
-
string
Referenční název typu pracovní položky pro pole
- fieldRefName
-
string
Název odkazu pole
Návraty
Promise<WorkItemTypeFieldModel2>
getWorkItemTypeFields(string, string)
Vrátí seznam všech polí v typu pracovní položky procesu.
function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>
Parametry
- processId
-
string
ID procesu
- witRefNameForFields
-
string
Referenční název typu pracovní položky pro pole
Návraty
Promise<WorkItemTypeFieldModel2[]>
getWorkItemTypes(string, GetWorkItemTypeExpand)
Vrátí seznam všech typů pracovních položek v procesu.
function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>
Parametry
- processId
-
string
ID procesu
- expand
- GetWorkItemTypeExpand
Návraty
Promise<WorkItemTypeModel[]>
hideStateDefinition(HideStateModel, string, string, string)
Skryje definici stavu v typu pracovní položky procesu.
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>
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
Referenční název 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ý se má odebrat
Návraty
Promise<void>
removeFieldFromWorkItemType(string, string, string)
Odebere pole v typu pracovní položky procesu.
function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>
Parametry
- processId
-
string
ID procesu
- witRefNameForFields
-
string
Referenční název typu pracovní položky pro pole
- fieldRefName
-
string
Název odkazu pole
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 je 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>
replaceBehavior(BehaviorReplaceModel, string, string)
Nahradí chování v procesu.
function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>
Parametry
- behaviorData
- BehaviorReplaceModel
- processId
-
string
ID procesu
- behaviorId
-
string
ID chování
Návraty
Promise<BehaviorModel>
setControlInGroup(Control, string, string, string, string, string)
Přesune ovládací prvek do nové skupiny.
function setControlInGroup(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
Skupina, ze které se má ovládací prvek odebrat
Návraty
Promise<Control>
setGroupInPage(Group, string, string, string, string, string, string, string)
Přesune skupinu na jinou stránku a oddíl.
function setGroupInPage(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é se skupina nachází
- groupId
-
string
ID skupiny
- removeFromPageId
-
string
ID stránky, ze které chcete odebrat skupinu
- removeFromSectionId
-
string
ID oddílu pro odebrání skupiny
Návraty
Promise<Group>
setGroupInSection(Group, string, string, string, string, string, string)
Přesune skupinu do jiného oddílu.
function setGroupInSection(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 pro odebrání skupiny
Návraty
Promise<Group>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Aktualizace výchozí typ pracovní položky pro chování 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>
updateField(FieldUpdate, string)
Aktualizace dané pole v procesu.
function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>
Parametry
- field
- FieldUpdate
- processId
-
string
ID procesu
Návraty
Promise<FieldModel>
updateList(PickListModel, string)
Aktualizace seznamu.
function updateList(picklist: PickListModel, listId: string): Promise<PickListModel>
Parametry
- picklist
- PickListModel
- listId
-
string
ID seznamu
Návraty
Promise<PickListModel>
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>
updateWorkItemType(WorkItemTypeUpdateModel, string, string)
Aktualizace typ pracovní položky procesu.
function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>
Parametry
- workItemTypeUpdate
- WorkItemTypeUpdateModel
- processId
-
string
ID procesu
- witRefName
-
string
Název odkazu typu pracovní položky
Návraty
Promise<WorkItemTypeModel>
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)
Aktualizace jedno pole v oboru daného procesu a typu pracovní položky.
function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>
Parametry
- field
- WorkItemTypeFieldModel2
Model, pomocí kterého se má pole aktualizovat
- processId
-
string
ID procesu
- witRefNameForFields
-
string
Referenční název typu pracovní položky pro pole
Návraty
Promise<WorkItemTypeFieldModel2>
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro