WorkItemTrackingProcessDefinitionsRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's
- Extends
Constructors
| Work |
Eigenschappen
| RESOURCE_AREA_ID |
Methoden
| add |
Hiermee voegt u een gedrag toe aan het type werkitem van het proces. |
| add |
Hiermee maakt u een besturingselement in een groep |
| add |
Hiermee voegt u een veld toe aan het type werkitem in het proces. |
| add |
Hiermee voegt u een groep toe aan het werkitemformulier |
| add |
Hiermee voegt u een pagina toe aan het werkitemformulier |
| create |
Hiermee maakt u één gedrag in het opgegeven proces. |
| create |
Hiermee maakt u één veld in het proces. |
| create |
Hiermee maakt u een selectielijst. |
| create |
Hiermee maakt u een statusdefinitie in het type werkitem van het proces. |
| create |
Hiermee maakt u een werkitemtype in het proces. |
| delete |
Hiermee verwijdert u een gedrag in het proces. |
| delete |
Hiermee verwijdert u een selectielijst. |
| delete |
Hiermee verwijdert u een statusdefinitie in het werkitemtype van het proces. |
| delete |
Hiermee verwijdert u een werkitemtype in het proces. |
| edit |
een besturingselement Updates op het formulier met werkitems |
| edit |
een groep Updates in het werkitemformulier |
| edit |
Updates een pagina in het werkitemformulier |
| get |
Retourneert één gedrag in het proces. |
| get |
Retourneert een gedrag voor het type werkitem van het proces. |
| get |
Retourneert een lijst met alle gedragingen in het proces. |
| get |
Retourneert een lijst met alle gedragingen voor het type werkitem van het proces. |
| get |
Hiermee haalt u de formulierindeling op |
| get |
Retourneert een selectielijst. |
| get |
Hiermee worden metagegevens van de selectielijst geretourneerd. |
| get |
Retourneert een statusdefinitie in het type werkitem van het proces. |
| get |
Retourneert een lijst met alle statusdefinities in het type werkitem van het proces. |
| get |
Retourneert een type werkitem van het proces. |
| get |
Retourneert één veld in het type werkitem van het proces. |
| get |
Retourneert een lijst met alle velden in het type werkitem van het proces. |
| get |
Retourneert een lijst met alle typen werkitems in het proces. |
| hide |
Hiermee verbergt u een statusdefinitie in het type werkitem van het proces. |
| remove |
Hiermee verwijdert u een gedrag voor het type werkitem van het proces. |
| remove |
Hiermee verwijdert u een besturingselement uit het werkitemformulier |
| remove |
Hiermee verwijdert u een veld in het werkitemtype van het proces. |
| remove |
Hiermee verwijdert u een groep uit het werkitemformulier |
| remove |
Hiermee verwijdert u een pagina uit het werkitemformulier |
| replace |
Vervangt een gedrag in het proces. |
| set |
Een besturingselement naar een nieuwe groep verplaatsen |
| set |
Een groep naar een andere pagina en sectie verplaatsen |
| set |
Een groep naar een andere sectie verplaatsen |
| update |
Updates standaardtype werkitem voor het gedrag van het proces. |
| update |
Updates een bepaald veld in het proces. |
| update |
Updates een lijst. |
| update |
Updates een bepaalde statusdefinitie in het type werkitem van het proces. |
| update |
Updates een type werkitem van het proces. |
| update |
Updates één veld in het bereik van het opgegeven type proces- en werkitem. |
Constructordetails
WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)Parameters
- options
- IVssRestClientOptions
Eigenschapdetails
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringWaarde van eigenschap
string
Methodedetails
addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Hiermee voegt u een gedrag toe aan het type werkitem van het proces.
function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Parameters
- behavior
- WorkItemTypeBehavior
- processId
-
string
De ID van het proces
- witRefNameForBehaviors
-
string
Verwijzingsnaam van werkitemtype voor het gedrag
Retouren
Promise<WorkItemTypeBehavior>
addControlToGroup(Control, string, string, string)
Hiermee maakt u een besturingselement in een groep
function addControlToGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>Parameters
- control
- Control
Het besturingselement
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- groupId
-
string
De id van de groep waaraan u het besturingselement wilt toevoegen
Retouren
Promise<Control>
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)
Hiermee voegt u een veld toe aan het type werkitem in het proces.
function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>Parameters
- field
- WorkItemTypeFieldModel2
- processId
-
string
De ID van het proces
- witRefNameForFields
-
string
Verwijzingsnaam van werkitemtype voor het veld
Retouren
Promise<WorkItemTypeFieldModel2>
addGroup(Group, string, string, string, string)
Hiermee voegt u een groep toe aan het werkitemformulier
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>Parameters
- group
- Group
De groep
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- pageId
-
string
De id van de pagina waaraan u de groep wilt toevoegen
- sectionId
-
string
De id van de sectie waaraan u de groep wilt toevoegen
Retouren
Promise<Group>
addPage(Page, string, string)
Hiermee voegt u een pagina toe aan het werkitemformulier
function addPage(page: Page, processId: string, witRefName: string): Promise<Page>Parameters
- page
- Page
De pagina
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<Page>
createBehavior(BehaviorCreateModel, string)
Hiermee maakt u één gedrag in het opgegeven proces.
function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>Parameters
- behavior
- BehaviorCreateModel
- processId
-
string
De ID van het proces
Retouren
Promise<BehaviorModel>
createField(FieldModel, string)
Hiermee maakt u één veld in het proces.
function createField(field: FieldModel, processId: string): Promise<FieldModel>Parameters
- field
- FieldModel
- processId
-
string
De ID van het proces
Retouren
Promise<FieldModel>
createList(PickListModel)
Hiermee maakt u een selectielijst.
function createList(picklist: PickListModel): Promise<PickListModel>Parameters
- picklist
- PickListModel
Retouren
Promise<PickListModel>
createStateDefinition(WorkItemStateInputModel, string, string)
Hiermee maakt u een statusdefinitie in het type werkitem van het proces.
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>Parameters
- stateModel
- WorkItemStateInputModel
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<WorkItemStateResultModel>
createWorkItemType(WorkItemTypeModel, string)
Hiermee maakt u een werkitemtype in het proces.
function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>Parameters
- workItemType
- WorkItemTypeModel
- processId
-
string
De ID van het proces
Retouren
Promise<WorkItemTypeModel>
deleteBehavior(string, string)
Hiermee verwijdert u een gedrag in het proces.
function deleteBehavior(processId: string, behaviorId: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- behaviorId
-
string
De id van het gedrag
Retouren
Promise<void>
deleteList(string)
Hiermee verwijdert u een selectielijst.
function deleteList(listId: string): Promise<void>Parameters
- listId
-
string
De id van de lijst
Retouren
Promise<void>
deleteStateDefinition(string, string, string)
Hiermee verwijdert u een statusdefinitie in het werkitemtype van het proces.
function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>Parameters
- processId
-
string
Id van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- stateId
-
string
Id van de status
Retouren
Promise<void>
deleteWorkItemType(string, string)
Hiermee verwijdert u een werkitemtype in het proces.
function deleteWorkItemType(processId: string, witRefName: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<void>
editControl(Control, string, string, string, string)
een besturingselement Updates op het formulier met werkitems
function editControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>Parameters
- control
- Control
Het bijgewerkte besturingselement
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- groupId
-
string
De id van de groep
- controlId
-
string
De id van het besturingselement
Retouren
Promise<Control>
editGroup(Group, string, string, string, string, string)
een groep Updates in het werkitemformulier
function editGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>Parameters
- group
- Group
De bijgewerkte groep
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- pageId
-
string
De id van de pagina waarin de groep zich bevindt
- sectionId
-
string
De id van de sectie waarin de groep zich bevindt
- groupId
-
string
De id van de groep
Retouren
Promise<Group>
editPage(Page, string, string)
Updates een pagina in het werkitemformulier
function editPage(page: Page, processId: string, witRefName: string): Promise<Page>Parameters
- page
- Page
De pagina
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<Page>
getBehavior(string, string)
Retourneert één gedrag in het proces.
function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>Parameters
- processId
-
string
De ID van het proces
- behaviorId
-
string
De id van het gedrag
Retouren
Promise<BehaviorModel>
getBehaviorForWorkItemType(string, string, string)
Retourneert een gedrag voor het type werkitem van het proces.
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>Parameters
- processId
-
string
De ID van het proces
- witRefNameForBehaviors
-
string
Verwijzingsnaam van werkitemtype voor het gedrag
- behaviorRefName
-
string
De verwijzingsnaam van het gedrag
Retouren
Promise<WorkItemTypeBehavior>
getBehaviors(string)
Retourneert een lijst met alle gedragingen in het proces.
function getBehaviors(processId: string): Promise<BehaviorModel[]>Parameters
- processId
-
string
De ID van het proces
Retouren
Promise<BehaviorModel[]>
getBehaviorsForWorkItemType(string, string)
Retourneert een lijst met alle gedragingen voor het type werkitem van het proces.
function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>Parameters
- processId
-
string
De ID van het proces
- witRefNameForBehaviors
-
string
Verwijzingsnaam van werkitemtype voor het gedrag
Retouren
Promise<WorkItemTypeBehavior[]>
getFormLayout(string, string)
Hiermee haalt u de formulierindeling op
function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<FormLayout>
getList(string)
Retourneert een selectielijst.
function getList(listId: string): Promise<PickListModel>Parameters
- listId
-
string
De id van de lijst
Retouren
Promise<PickListModel>
getListsMetadata()
Hiermee worden metagegevens van de selectielijst geretourneerd.
function getListsMetadata(): Promise<PickListMetadataModel[]>Retouren
Promise<PickListMetadataModel[]>
getStateDefinition(string, string, string)
Retourneert een statusdefinitie in het type werkitem van het proces.
function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- stateId
-
string
De id van de status
Retouren
Promise<WorkItemStateResultModel>
getStateDefinitions(string, string)
Retourneert een lijst met alle statusdefinities in het type werkitem van het proces.
function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<WorkItemStateResultModel[]>
getWorkItemType(string, string, GetWorkItemTypeExpand)
Retourneert een type werkitem van het proces.
function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- expand
- GetWorkItemTypeExpand
Retouren
Promise<WorkItemTypeModel>
getWorkItemTypeField(string, string, string)
Retourneert één veld in het type werkitem van het proces.
function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>Parameters
- processId
-
string
De ID van het proces
- witRefNameForFields
-
string
Verwijzingsnaam van werkitemtype voor velden
- fieldRefName
-
string
De verwijzingsnaam van het veld
Retouren
Promise<WorkItemTypeFieldModel2>
getWorkItemTypeFields(string, string)
Retourneert een lijst met alle velden in het type werkitem van het proces.
function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>Parameters
- processId
-
string
De ID van het proces
- witRefNameForFields
-
string
Verwijzingsnaam van werkitemtype voor velden
Retouren
Promise<WorkItemTypeFieldModel2[]>
getWorkItemTypes(string, GetWorkItemTypeExpand)
Retourneert een lijst met alle typen werkitems in het proces.
function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>Parameters
- processId
-
string
De ID van het proces
- expand
- GetWorkItemTypeExpand
Retouren
Promise<WorkItemTypeModel[]>
hideStateDefinition(HideStateModel, string, string, string)
Hiermee verbergt u een statusdefinitie in het type werkitem van het proces.
function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Parameters
- hideStateModel
- HideStateModel
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- stateId
-
string
De id van de status
Retouren
Promise<WorkItemStateResultModel>
removeBehaviorFromWorkItemType(string, string, string)
Hiermee verwijdert u een gedrag voor het type werkitem van het proces.
function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- witRefNameForBehaviors
-
string
Verwijzingsnaam van werkitemtype voor het gedrag
- behaviorRefName
-
string
De verwijzingsnaam van het gedrag
Retouren
Promise<void>
removeControlFromGroup(string, string, string, string)
Hiermee verwijdert u een besturingselement uit het werkitemformulier
function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- groupId
-
string
De id van de groep
- controlId
-
string
De id van het besturingselement dat moet worden verwijderd
Retouren
Promise<void>
removeFieldFromWorkItemType(string, string, string)
Hiermee verwijdert u een veld in het werkitemtype van het proces.
function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- witRefNameForFields
-
string
Verwijzingsnaam van werkitemtype voor velden
- fieldRefName
-
string
De verwijzingsnaam van het veld
Retouren
Promise<void>
removeGroup(string, string, string, string, string)
Hiermee verwijdert u een groep uit het werkitemformulier
function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- pageId
-
string
De id van de pagina waarin de groep zich bevindt
- sectionId
-
string
De id van de sectie voor de groep bevindt zich in
- groupId
-
string
De id van de groep
Retouren
Promise<void>
removePage(string, string, string)
Hiermee verwijdert u een pagina uit het werkitemformulier
function removePage(processId: string, witRefName: string, pageId: string): Promise<void>Parameters
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- pageId
-
string
De id van de pagina
Retouren
Promise<void>
replaceBehavior(BehaviorReplaceModel, string, string)
Vervangt een gedrag in het proces.
function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>Parameters
- behaviorData
- BehaviorReplaceModel
- processId
-
string
De ID van het proces
- behaviorId
-
string
De id van het gedrag
Retouren
Promise<BehaviorModel>
setControlInGroup(Control, string, string, string, string, string)
Een besturingselement naar een nieuwe groep verplaatsen
function setControlInGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>Parameters
- control
- Control
Het besturingselement
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- groupId
-
string
De id van de groep waar het besturingselement naar moet worden verplaatst
- controlId
-
string
De id van het besturingselement
- removeFromGroupId
-
string
De groep waaruit het besturingselement moet worden verwijderd
Retouren
Promise<Control>
setGroupInPage(Group, string, string, string, string, string, string, string)
Een groep naar een andere pagina en sectie verplaatsen
function setGroupInPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>Parameters
- group
- Group
De bijgewerkte groep
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- pageId
-
string
De id van de pagina waarin de groep zich bevindt
- sectionId
-
string
De id van de sectie waarin de groep zich bevindt
- groupId
-
string
De id van de groep
- removeFromPageId
-
string
Id van de pagina waaruit de groep moet worden verwijderd
- removeFromSectionId
-
string
Id van de sectie waaruit de groep moet worden verwijderd
Retouren
Promise<Group>
setGroupInSection(Group, string, string, string, string, string, string)
Een groep naar een andere sectie verplaatsen
function setGroupInSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>Parameters
- group
- Group
De bijgewerkte groep
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- pageId
-
string
De id van de pagina waarin de groep zich bevindt
- sectionId
-
string
De id van de sectie waarin de groep zich bevindt
- groupId
-
string
De id van de groep
- removeFromSectionId
-
string
Id van de sectie waaruit de groep moet worden verwijderd
Retouren
Promise<Group>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Updates standaardtype werkitem voor het gedrag van het proces.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Parameters
- behavior
- WorkItemTypeBehavior
- processId
-
string
De ID van het proces
- witRefNameForBehaviors
-
string
Verwijzingsnaam van werkitemtype voor het gedrag
Retouren
Promise<WorkItemTypeBehavior>
updateField(FieldUpdate, string)
Updates een bepaald veld in het proces.
function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>Parameters
- field
- FieldUpdate
- processId
-
string
De ID van het proces
Retouren
Promise<FieldModel>
updateList(PickListModel, string)
Updates een lijst.
function updateList(picklist: PickListModel, listId: string): Promise<PickListModel>Parameters
- picklist
- PickListModel
- listId
-
string
De id van de lijst
Retouren
Promise<PickListModel>
updateStateDefinition(WorkItemStateInputModel, string, string, string)
Updates een bepaalde statusdefinitie in het type werkitem van het proces.
function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>Parameters
- stateModel
- WorkItemStateInputModel
- processId
-
string
Id van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
- stateId
-
string
Id van de status
Retouren
Promise<WorkItemStateResultModel>
updateWorkItemType(WorkItemTypeUpdateModel, string, string)
Updates een type werkitem van het proces.
function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>Parameters
- workItemTypeUpdate
- WorkItemTypeUpdateModel
- processId
-
string
De ID van het proces
- witRefName
-
string
De verwijzingsnaam van het type werkitem
Retouren
Promise<WorkItemTypeModel>
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)
Updates één veld in het bereik van het opgegeven type proces- en werkitem.
function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>Parameters
- field
- WorkItemTypeFieldModel2
Het model waarmee het veld moet worden bijgewerkt
- processId
-
string
De ID van het proces
- witRefNameForFields
-
string
Verwijzingsnaam van werkitemtype voor velden
Retouren
Promise<WorkItemTypeFieldModel2>