WorkItemTrackingProcessDefinitionsRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Tulajdonságok
| RESOURCE_AREA_ID |
Metódusok
| add |
Viselkedést ad hozzá a folyamat munkaelem-típusához. |
| add |
Vezérlő létrehozása egy csoportban |
| add |
Egy mezőt ad hozzá a folyamat munkaelem-típusához. |
| add |
Csoport hozzáadása a munkaelem-űrlaphoz |
| add |
Lap hozzáadása a munkaelem-űrlaphoz |
| create |
Egyetlen viselkedést hoz létre az adott folyamatban. |
| create |
Egyetlen mezőt hoz létre a folyamatban. |
| create |
Létrehoz egy kiválasztólistát. |
| create |
Létrehoz egy állapotdefiníciót a folyamat munkaelem-típusában. |
| create |
Létrehoz egy munkaelemtípust a folyamatban. |
| delete |
Eltávolítja a folyamat viselkedését. |
| delete |
Eltávolítja a listát. |
| delete |
Eltávolít egy állapotdefiníciót a folyamat munkaelem-típusában. |
| delete |
Eltávolít egy munkaelemtípust a folyamatban. |
| edit |
Vezérlő frissítése a munkaeleműrlapon |
| edit |
Csoport frissítése a munkaelem űrlapon |
| edit |
Oldal frissítése a munkaeleműrlapon |
| get |
Egyetlen viselkedést ad vissza a folyamatban. |
| get |
A folyamat munkaelem-típusának viselkedését adja vissza. |
| get |
A folyamat összes viselkedésének listáját adja vissza. |
| get |
A folyamat munkaelem-típusához tartozó összes viselkedés listáját adja vissza. |
| get |
Lekéri az űrlapelrendezést |
| get |
Egy kiválasztólistát ad vissza. |
| get |
A picklist metaadatait adja vissza. |
| get |
Egy állapotdefiníciót ad vissza a folyamat munkaelem-típusában. |
| get |
A folyamat munkaelem-típusában szereplő összes állapotdefiníció listáját adja vissza. |
| get |
A folyamat munkaelem-típusát adja vissza. |
| get |
Egyetlen mezőt ad vissza a folyamat munkaelem-típusában. |
| get |
A folyamat munkaelem-típusában szereplő összes mező listáját adja vissza. |
| get |
A folyamat összes munkaelem-típusának listáját adja vissza. |
| hide |
Elrejt egy állapotdefiníciót a folyamat munkaelem-típusában. |
| remove |
Eltávolítja a folyamat munkaelem-típusának viselkedését. |
| remove |
Vezérlő eltávolítása a munkaeleműrlapról |
| remove |
Eltávolít egy mezőt a folyamat munkaelem-típusából. |
| remove |
Csoport eltávolítása a munkaelem-űrlapról |
| remove |
Oldal eltávolítása a munkaelem-űrlapról |
| replace |
A folyamat viselkedését cseréli le. |
| set |
Vezérlőelem áthelyezése új csoportba |
| set |
Csoport áthelyezése másik lapra és szakaszra |
| set |
Csoport áthelyezése másik szakaszba |
| update |
Frissíti a folyamat viselkedésének alapértelmezett munkaelemtípusát. |
| update |
Frissíti a folyamat adott mezőjét. |
| update |
Lista frissítése. |
| update |
Frissíti az adott állapotdefiníciót a folyamat munkaelem-típusában. |
| update |
Frissíti a folyamat munkaelem-típusát. |
| update |
Egyetlen mezőt frissít az adott folyamat- és munkaelem-típus hatókörében. |
Konstruktor adatai
WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)Paraméterek
- options
- IVssRestClientOptions
Tulajdonság adatai
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringTulajdonság értéke
string
Metódus adatai
addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Viselkedést ad hozzá a folyamat munkaelem-típusához.
function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Paraméterek
- behavior
- WorkItemTypeBehavior
- processId
-
string
A folyamat azonosítója
- witRefNameForBehaviors
-
string
A viselkedés munkaelemtípus-hivatkozásának neve
Válaszok
Promise<WorkItemTypeBehavior>
addControlToGroup(Control, string, string, string)
Vezérlő létrehozása egy csoportban
function addControlToGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>Paraméterek
- control
- Control
A vezérlő
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- groupId
-
string
Annak a csoportnak az azonosítója, amelybe a vezérlőt fel szeretné adni
Válaszok
Promise<Control>
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)
Egy mezőt ad hozzá a folyamat munkaelem-típusához.
function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>Paraméterek
- field
- WorkItemTypeFieldModel2
- processId
-
string
A folyamat azonosítója
- witRefNameForFields
-
string
A mező munkaelemtípus-hivatkozásának neve
Válaszok
Promise<WorkItemTypeFieldModel2>
addGroup(Group, string, string, string, string)
Csoport hozzáadása a munkaelem-űrlaphoz
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>Paraméterek
- group
- Group
A csoport
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- pageId
-
string
Annak a lapnak az azonosítója, amelybe a csoportot fel szeretné adni
- sectionId
-
string
Annak a szakasznak az azonosítója, amelybe a csoportot fel szeretné adni
Válaszok
Promise<Group>
addPage(Page, string, string)
createBehavior(BehaviorCreateModel, string)
Egyetlen viselkedést hoz létre az adott folyamatban.
function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>Paraméterek
- behavior
- BehaviorCreateModel
- processId
-
string
A folyamat azonosítója
Válaszok
Promise<BehaviorModel>
createField(FieldModel, string)
Egyetlen mezőt hoz létre a folyamatban.
function createField(field: FieldModel, processId: string): Promise<FieldModel>Paraméterek
- field
- FieldModel
- processId
-
string
A folyamat azonosítója
Válaszok
Promise<FieldModel>
createList(PickListModel)
Létrehoz egy kiválasztólistát.
function createList(picklist: PickListModel): Promise<PickListModel>Paraméterek
- picklist
- PickListModel
Válaszok
Promise<PickListModel>
createStateDefinition(WorkItemStateInputModel, string, string)
Létrehoz egy állapotdefiníciót a folyamat munkaelem-típusában.
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>Paraméterek
- stateModel
- WorkItemStateInputModel
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
Válaszok
Promise<WorkItemStateResultModel>
createWorkItemType(WorkItemTypeModel, string)
Létrehoz egy munkaelemtípust a folyamatban.
function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>Paraméterek
- workItemType
- WorkItemTypeModel
- processId
-
string
A folyamat azonosítója
Válaszok
Promise<WorkItemTypeModel>
deleteBehavior(string, string)
Eltávolítja a folyamat viselkedését.
function deleteBehavior(processId: string, behaviorId: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- behaviorId
-
string
A viselkedés azonosítója
Válaszok
Promise<void>
deleteList(string)
Eltávolítja a listát.
function deleteList(listId: string): Promise<void>Paraméterek
- listId
-
string
A lista azonosítója
Válaszok
Promise<void>
deleteStateDefinition(string, string, string)
Eltávolít egy állapotdefiníciót a folyamat munkaelem-típusában.
function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- stateId
-
string
Az állapot azonosítója
Válaszok
Promise<void>
deleteWorkItemType(string, string)
Eltávolít egy munkaelemtípust a folyamatban.
function deleteWorkItemType(processId: string, witRefName: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
Válaszok
Promise<void>
editControl(Control, string, string, string, string)
Vezérlő frissítése a munkaeleműrlapon
function editControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>Paraméterek
- control
- Control
A frissített vezérlő
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- groupId
-
string
A csoport azonosítója
- controlId
-
string
A vezérlő azonosítója
Válaszok
Promise<Control>
editGroup(Group, string, string, string, string, string)
Csoport frissítése a munkaelem űrlapon
function editGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>Paraméterek
- group
- Group
A frissített csoport
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- pageId
-
string
Annak a lapnak az azonosítója, amelyben a csoport található
- sectionId
-
string
Annak a szakasznak az azonosítója, amelyben a csoport szerepel
- groupId
-
string
A csoport azonosítója
Válaszok
Promise<Group>
editPage(Page, string, string)
getBehavior(string, string)
Egyetlen viselkedést ad vissza a folyamatban.
function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>Paraméterek
- processId
-
string
A folyamat azonosítója
- behaviorId
-
string
A viselkedés azonosítója
Válaszok
Promise<BehaviorModel>
getBehaviorForWorkItemType(string, string, string)
A folyamat munkaelem-típusának viselkedését adja vissza.
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefNameForBehaviors
-
string
A viselkedés munkaelemtípus-hivatkozásának neve
- behaviorRefName
-
string
A viselkedés referencianeve
Válaszok
Promise<WorkItemTypeBehavior>
getBehaviors(string)
A folyamat összes viselkedésének listáját adja vissza.
function getBehaviors(processId: string): Promise<BehaviorModel[]>Paraméterek
- processId
-
string
A folyamat azonosítója
Válaszok
Promise<BehaviorModel[]>
getBehaviorsForWorkItemType(string, string)
A folyamat munkaelem-típusához tartozó összes viselkedés listáját adja vissza.
function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefNameForBehaviors
-
string
A viselkedés munkaelemtípus-hivatkozásának neve
Válaszok
Promise<WorkItemTypeBehavior[]>
getFormLayout(string, string)
Lekéri az űrlapelrendezést
function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
Válaszok
Promise<FormLayout>
getList(string)
Egy kiválasztólistát ad vissza.
function getList(listId: string): Promise<PickListModel>Paraméterek
- listId
-
string
A lista azonosítója
Válaszok
Promise<PickListModel>
getListsMetadata()
A picklist metaadatait adja vissza.
function getListsMetadata(): Promise<PickListMetadataModel[]>Válaszok
Promise<PickListMetadataModel[]>
getStateDefinition(string, string, string)
Egy állapotdefiníciót ad vissza a folyamat munkaelem-típusában.
function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- stateId
-
string
Az állapot azonosítója
Válaszok
Promise<WorkItemStateResultModel>
getStateDefinitions(string, string)
A folyamat munkaelem-típusában szereplő összes állapotdefiníció listáját adja vissza.
function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
Válaszok
Promise<WorkItemStateResultModel[]>
getWorkItemType(string, string, GetWorkItemTypeExpand)
A folyamat munkaelem-típusát adja vissza.
function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- expand
- GetWorkItemTypeExpand
Válaszok
Promise<WorkItemTypeModel>
getWorkItemTypeField(string, string, string)
Egyetlen mezőt ad vissza a folyamat munkaelem-típusában.
function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefNameForFields
-
string
Munkaelemtípus hivatkozásának neve mezőkhöz
- fieldRefName
-
string
A mező referencianeve
Válaszok
Promise<WorkItemTypeFieldModel2>
getWorkItemTypeFields(string, string)
A folyamat munkaelem-típusában szereplő összes mező listáját adja vissza.
function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefNameForFields
-
string
Munkaelemtípus hivatkozásának neve mezőkhöz
Válaszok
Promise<WorkItemTypeFieldModel2[]>
getWorkItemTypes(string, GetWorkItemTypeExpand)
A folyamat összes munkaelem-típusának listáját adja vissza.
function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>Paraméterek
- processId
-
string
A folyamat azonosítója
- expand
- GetWorkItemTypeExpand
Válaszok
Promise<WorkItemTypeModel[]>
hideStateDefinition(HideStateModel, string, string, string)
Elrejt egy állapotdefiníciót a folyamat munkaelem-típusában.
function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Paraméterek
- hideStateModel
- HideStateModel
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- stateId
-
string
Az állapot azonosítója
Válaszok
Promise<WorkItemStateResultModel>
removeBehaviorFromWorkItemType(string, string, string)
Eltávolítja a folyamat munkaelem-típusának viselkedését.
function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefNameForBehaviors
-
string
A viselkedés munkaelemtípus-hivatkozásának neve
- behaviorRefName
-
string
A viselkedés referencianeve
Válaszok
Promise<void>
removeControlFromGroup(string, string, string, string)
Vezérlő eltávolítása a munkaeleműrlapról
function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- groupId
-
string
A csoport azonosítója
- controlId
-
string
Az eltávolítani kívánt vezérlő azonosítója
Válaszok
Promise<void>
removeFieldFromWorkItemType(string, string, string)
Eltávolít egy mezőt a folyamat munkaelem-típusából.
function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefNameForFields
-
string
Munkaelemtípus hivatkozásának neve mezőkhöz
- fieldRefName
-
string
A mező referencianeve
Válaszok
Promise<void>
removeGroup(string, string, string, string, string)
Csoport eltávolítása a munkaelem-űrlapról
function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- pageId
-
string
Annak a lapnak az azonosítója, amelyben a csoport található
- sectionId
-
string
A csoporthoz tartozó szakasz azonosítója a következő:
- groupId
-
string
A csoport azonosítója
Válaszok
Promise<void>
removePage(string, string, string)
Oldal eltávolítása a munkaelem-űrlapról
function removePage(processId: string, witRefName: string, pageId: string): Promise<void>Paraméterek
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- pageId
-
string
A lap azonosítója
Válaszok
Promise<void>
replaceBehavior(BehaviorReplaceModel, string, string)
A folyamat viselkedését cseréli le.
function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>Paraméterek
- behaviorData
- BehaviorReplaceModel
- processId
-
string
A folyamat azonosítója
- behaviorId
-
string
A viselkedés azonosítója
Válaszok
Promise<BehaviorModel>
setControlInGroup(Control, string, string, string, string, string)
Vezérlőelem áthelyezése új csoportba
function setControlInGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>Paraméterek
- control
- Control
A vezérlő
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- groupId
-
string
Annak a csoportnak az azonosítója, amelybe a vezérlőt át szeretné helyezni
- controlId
-
string
A vezérlő azonosítója
- removeFromGroupId
-
string
Az a csoport, amelyből eltávolítja a vezérlőt
Válaszok
Promise<Control>
setGroupInPage(Group, string, string, string, string, string, string, string)
Csoport áthelyezése másik lapra és szakaszra
function setGroupInPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>Paraméterek
- group
- Group
A frissített csoport
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- pageId
-
string
Annak a lapnak az azonosítója, amelyben a csoport található
- sectionId
-
string
Annak a szakasznak az azonosítója, amelyben a csoport szerepel
- groupId
-
string
A csoport azonosítója
- removeFromPageId
-
string
A csoport eltávolításához a lap azonosítója
- removeFromSectionId
-
string
A csoport eltávolításához a szakasz azonosítója
Válaszok
Promise<Group>
setGroupInSection(Group, string, string, string, string, string, string)
Csoport áthelyezése másik szakaszba
function setGroupInSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>Paraméterek
- group
- Group
A frissített csoport
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- pageId
-
string
Annak a lapnak az azonosítója, amelyben a csoport található
- sectionId
-
string
Annak a szakasznak az azonosítója, amelyben a csoport szerepel
- groupId
-
string
A csoport azonosítója
- removeFromSectionId
-
string
A csoport eltávolításához a szakasz azonosítója
Válaszok
Promise<Group>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Frissíti a folyamat viselkedésének alapértelmezett munkaelemtípusát.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Paraméterek
- behavior
- WorkItemTypeBehavior
- processId
-
string
A folyamat azonosítója
- witRefNameForBehaviors
-
string
A viselkedés munkaelemtípus-hivatkozásának neve
Válaszok
Promise<WorkItemTypeBehavior>
updateField(FieldUpdate, string)
Frissíti a folyamat adott mezőjét.
function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>Paraméterek
- field
- FieldUpdate
- processId
-
string
A folyamat azonosítója
Válaszok
Promise<FieldModel>
updateList(PickListModel, string)
Lista frissítése.
function updateList(picklist: PickListModel, listId: string): Promise<PickListModel>Paraméterek
- picklist
- PickListModel
- listId
-
string
A lista azonosítója
Válaszok
Promise<PickListModel>
updateStateDefinition(WorkItemStateInputModel, string, string, string)
Frissíti az adott állapotdefiníciót a folyamat munkaelem-típusában.
function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Paraméterek
- stateModel
- WorkItemStateInputModel
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
- stateId
-
string
Az állapot azonosítója
Válaszok
Promise<WorkItemStateResultModel>
updateWorkItemType(WorkItemTypeUpdateModel, string, string)
Frissíti a folyamat munkaelem-típusát.
function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>Paraméterek
- workItemTypeUpdate
- WorkItemTypeUpdateModel
- processId
-
string
A folyamat azonosítója
- witRefName
-
string
A munkaelem-típus hivatkozásneve
Válaszok
Promise<WorkItemTypeModel>
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)
Egyetlen mezőt frissít az adott folyamat- és munkaelem-típus hatókörében.
function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>Paraméterek
- field
- WorkItemTypeFieldModel2
Az a modell, amellyel frissíteni szeretné a mezőt
- processId
-
string
A folyamat azonosítója
- witRefNameForFields
-
string
Munkaelemtípus hivatkozásának neve mezőkhöz
Válaszok
Promise<WorkItemTypeFieldModel2>