Partager via


WorkItemTrackingProcessDefinitionsRestClient class

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

Constructeurs

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Ajoute un comportement au type d’élément de travail du processus.

addControlToGroup(Control, string, string, string)

Crée un contrôle dans un groupe

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Ajoute un champ au type d’élément de travail dans le processus.

addGroup(Group, string, string, string, string)

Ajoute un groupe au formulaire d’élément de travail

addPage(Page, string, string)

Ajoute une page au formulaire d’élément de travail

createBehavior(BehaviorCreateModel, string)

Crée un seul comportement dans le processus donné.

createField(FieldModel, string)

Crée un champ unique dans le processus.

createList(PickListModel)

Crée une liste de choix.

createStateDefinition(WorkItemStateInputModel, string, string)

Crée une définition d’état dans le type d’élément de travail du processus.

createWorkItemType(WorkItemTypeModel, string)

Crée un type d’élément de travail dans le processus.

deleteBehavior(string, string)

Supprime un comportement dans le processus.

deleteList(string)

Supprime une liste de choix.

deleteStateDefinition(string, string, string)

Supprime une définition d’état dans le type d’élément de travail du processus.

deleteWorkItemType(string, string)

Supprime un type d’élément de travail dans le processus.

editControl(Control, string, string, string, string)

Mises à jour un contrôle sur le formulaire d’élément de travail

editGroup(Group, string, string, string, string, string)

Mises à jour un groupe dans le formulaire d’élément de travail

editPage(Page, string, string)

Mises à jour une page dans le formulaire d’élément de travail

getBehavior(string, string)

Retourne un seul comportement dans le processus.

getBehaviorForWorkItemType(string, string, string)

Retourne un comportement pour le type d’élément de travail du processus.

getBehaviors(string)

Retourne une liste de tous les comportements du processus.

getBehaviorsForWorkItemType(string, string)

Retourne une liste de tous les comportements pour le type d’élément de travail du processus.

getFormLayout(string, string)

Obtient la disposition du formulaire

getList(string)

Retourne une liste de choix.

getListsMetadata()

Retourne les métadonnées de la liste de sélection.

getStateDefinition(string, string, string)

Retourne une définition d’état dans le type d’élément de travail du processus.

getStateDefinitions(string, string)

Retourne une liste de toutes les définitions d’état dans le type d’élément de travail du processus.

getWorkItemType(string, string, GetWorkItemTypeExpand)

Retourne un type d’élément de travail du processus.

getWorkItemTypeField(string, string, string)

Retourne un champ unique dans le type d’élément de travail du processus.

getWorkItemTypeFields(string, string)

Retourne la liste de tous les champs du type d’élément de travail du processus.

getWorkItemTypes(string, GetWorkItemTypeExpand)

Retourne une liste de tous les types d’éléments de travail dans le processus.

hideStateDefinition(HideStateModel, string, string, string)

Masque une définition d’état dans le type d’élément de travail du processus.

removeBehaviorFromWorkItemType(string, string, string)

Supprime un comportement pour le type d’élément de travail du processus.

removeControlFromGroup(string, string, string, string)

Supprime un contrôle du formulaire d’élément de travail

removeFieldFromWorkItemType(string, string, string)

Supprime un champ dans le type d’élément de travail du processus.

removeGroup(string, string, string, string, string)

Supprime un groupe du formulaire d’élément de travail

removePage(string, string, string)

Supprime une page du formulaire d’élément de travail

replaceBehavior(BehaviorReplaceModel, string, string)

Remplace un comportement dans le processus.

setControlInGroup(Control, string, string, string, string, string)

Déplace un contrôle vers un nouveau groupe

setGroupInPage(Group, string, string, string, string, string, string, string)

Déplace un groupe vers une page et une section différentes

setGroupInSection(Group, string, string, string, string, string, string)

Déplace un groupe vers une autre section

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Mises à jour type d’élément de travail par défaut pour le comportement du processus.

updateField(FieldUpdate, string)

Mises à jour un champ donné dans le processus.

updateList(PickListModel, string)

Mises à jour une liste.

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Mises à jour une définition d’état donnée dans le type d’élément de travail du processus.

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Mises à jour un type d’élément de travail du processus.

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Mises à jour un seul champ dans l’étendue du processus et du type d’élément de travail donnés.

Détails du constructeur

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Ajoute un comportement au type d’élément de travail du processus.

function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>

Paramètres

processId

string

ID du processus

witRefNameForBehaviors

string

Nom de référence du type d’élément de travail pour le comportement

Retours

addControlToGroup(Control, string, string, string)

Crée un contrôle dans un groupe

function addControlToGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>

Paramètres

control
Control

Contrôle

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

groupId

string

ID du groupe auquel ajouter le contrôle

Retours

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Ajoute un champ au type d’élément de travail dans le processus.

function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

Paramètres

processId

string

ID du processus

witRefNameForFields

string

Nom de référence du type d’élément de travail pour le champ

Retours

addGroup(Group, string, string, string, string)

Ajoute un groupe au formulaire d’élément de travail

function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>

Paramètres

group
Group

Le groupe

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

pageId

string

ID de la page à laquelle ajouter le groupe

sectionId

string

ID de la section à laquelle ajouter le groupe

Retours

Promise<Group>

addPage(Page, string, string)

Ajoute une page au formulaire d’élément de travail

function addPage(page: Page, processId: string, witRefName: string): Promise<Page>

Paramètres

page
Page

La page

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

Promise<Page>

createBehavior(BehaviorCreateModel, string)

Crée un seul comportement dans le processus donné.

function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>

Paramètres

processId

string

ID du processus

Retours

Promise<BehaviorModel>

createField(FieldModel, string)

Crée un champ unique dans le processus.

function createField(field: FieldModel, processId: string): Promise<FieldModel>

Paramètres

field
FieldModel
processId

string

ID du processus

Retours

Promise<FieldModel>

createList(PickListModel)

Crée une liste de choix.

function createList(picklist: PickListModel): Promise<PickListModel>

Paramètres

picklist
PickListModel

Retours

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

Crée une définition d’état dans le type d’élément de travail du processus.

function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

createWorkItemType(WorkItemTypeModel, string)

Crée un type d’élément de travail dans le processus.

function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>

Paramètres

workItemType
WorkItemTypeModel
processId

string

ID du processus

Retours

deleteBehavior(string, string)

Supprime un comportement dans le processus.

function deleteBehavior(processId: string, behaviorId: string): Promise<void>

Paramètres

processId

string

ID du processus

behaviorId

string

ID du comportement

Retours

Promise<void>

deleteList(string)

Supprime une liste de choix.

function deleteList(listId: string): Promise<void>

Paramètres

listId

string

ID de la liste

Retours

Promise<void>

deleteStateDefinition(string, string, string)

Supprime une définition d’état dans le type d’élément de travail du processus.

function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

stateId

string

ID de l’état

Retours

Promise<void>

deleteWorkItemType(string, string)

Supprime un type d’élément de travail dans le processus.

function deleteWorkItemType(processId: string, witRefName: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

Promise<void>

editControl(Control, string, string, string, string)

Mises à jour un contrôle sur le formulaire d’élément de travail

function editControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>

Paramètres

control
Control

Contrôle mis à jour

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

groupId

string

ID du groupe

controlId

string

ID du contrôle

Retours

Promise<Control>

editGroup(Group, string, string, string, string, string)

Mises à jour un groupe dans le formulaire d’élément de travail

function editGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>

Paramètres

group
Group

Groupe mis à jour

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

pageId

string

ID de la page dans laquelle se trouve le groupe

sectionId

string

ID de la section dans laquelle se trouve le groupe

groupId

string

ID du groupe

Retours

Promise<Group>

editPage(Page, string, string)

Mises à jour une page dans le formulaire d’élément de travail

function editPage(page: Page, processId: string, witRefName: string): Promise<Page>

Paramètres

page
Page

La page

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

Promise<Page>

getBehavior(string, string)

Retourne un seul comportement dans le processus.

function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>

Paramètres

processId

string

ID du processus

behaviorId

string

ID du comportement

Retours

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

Retourne un comportement pour le type d’élément de travail du processus.

function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>

Paramètres

processId

string

ID du processus

witRefNameForBehaviors

string

Nom de référence du type d’élément de travail pour le comportement

behaviorRefName

string

Nom de référence du comportement

Retours

getBehaviors(string)

Retourne une liste de tous les comportements du processus.

function getBehaviors(processId: string): Promise<BehaviorModel[]>

Paramètres

processId

string

ID du processus

Retours

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

Retourne une liste de tous les comportements pour le type d’élément de travail du processus.

function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>

Paramètres

processId

string

ID du processus

witRefNameForBehaviors

string

Nom de référence du type d’élément de travail pour le comportement

Retours

getFormLayout(string, string)

Obtient la disposition du formulaire

function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

Promise<FormLayout>

getList(string)

Retourne une liste de choix.

function getList(listId: string): Promise<PickListModel>

Paramètres

listId

string

ID de la liste

Retours

Promise<PickListModel>

getListsMetadata()

Retourne les métadonnées de la liste de sélection.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Retours

getStateDefinition(string, string, string)

Retourne une définition d’état dans le type d’élément de travail du processus.

function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

stateId

string

ID de l’état

Retours

getStateDefinitions(string, string)

Retourne une liste de toutes les définitions d’état dans le type d’élément de travail du processus.

function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

getWorkItemType(string, string, GetWorkItemTypeExpand)

Retourne un type d’élément de travail du processus.

function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

getWorkItemTypeField(string, string, string)

Retourne un champ unique dans le type d’élément de travail du processus.

function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>

Paramètres

processId

string

ID du processus

witRefNameForFields

string

Nom de référence du type d’élément de travail pour les champs

fieldRefName

string

Nom de référence du champ

Retours

getWorkItemTypeFields(string, string)

Retourne la liste de tous les champs du type d’élément de travail du processus.

function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>

Paramètres

processId

string

ID du processus

witRefNameForFields

string

Nom de référence du type d’élément de travail pour les champs

Retours

getWorkItemTypes(string, GetWorkItemTypeExpand)

Retourne une liste de tous les types d’éléments de travail dans le processus.

function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>

Paramètres

processId

string

ID du processus

Retours

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

Masque une définition d’état dans le type d’élément de travail du processus.

function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Paramètres

hideStateModel
HideStateModel
processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

stateId

string

ID de l’état

Retours

removeBehaviorFromWorkItemType(string, string, string)

Supprime un comportement pour le type d’élément de travail du processus.

function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefNameForBehaviors

string

Nom de référence du type d’élément de travail pour le comportement

behaviorRefName

string

Nom de référence du comportement

Retours

Promise<void>

removeControlFromGroup(string, string, string, string)

Supprime un contrôle du formulaire d’élément de travail

function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

groupId

string

ID du groupe

controlId

string

ID du contrôle à supprimer

Retours

Promise<void>

removeFieldFromWorkItemType(string, string, string)

Supprime un champ dans le type d’élément de travail du processus.

function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefNameForFields

string

Nom de référence du type d’élément de travail pour les champs

fieldRefName

string

Nom de référence du champ

Retours

Promise<void>

removeGroup(string, string, string, string, string)

Supprime un groupe du formulaire d’élément de travail

function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

pageId

string

ID de la page dans laquelle se trouve le groupe

sectionId

string

L’ID de la section du groupe se trouve dans

groupId

string

ID du groupe

Retours

Promise<void>

removePage(string, string, string)

Supprime une page du formulaire d’élément de travail

function removePage(processId: string, witRefName: string, pageId: string): Promise<void>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

pageId

string

ID de la page

Retours

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

Remplace un comportement dans le processus.

function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>

Paramètres

behaviorData
BehaviorReplaceModel
processId

string

ID du processus

behaviorId

string

ID du comportement

Retours

Promise<BehaviorModel>

setControlInGroup(Control, string, string, string, string, string)

Déplace un contrôle vers un nouveau groupe

function setControlInGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>

Paramètres

control
Control

Contrôle

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

groupId

string

ID du groupe vers lequel déplacer le contrôle

controlId

string

ID du contrôle

removeFromGroupId

string

Groupe à partir duquel supprimer le contrôle

Retours

Promise<Control>

setGroupInPage(Group, string, string, string, string, string, string, string)

Déplace un groupe vers une page et une section différentes

function setGroupInPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>

Paramètres

group
Group

Groupe mis à jour

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

pageId

string

ID de la page dans laquelle se trouve le groupe

sectionId

string

ID de la section dans laquelle se trouve le groupe

groupId

string

ID du groupe

removeFromPageId

string

ID de la page à partir de laquelle supprimer le groupe

removeFromSectionId

string

ID de la section à partir de laquelle supprimer le groupe

Retours

Promise<Group>

setGroupInSection(Group, string, string, string, string, string, string)

Déplace un groupe vers une autre section

function setGroupInSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>

Paramètres

group
Group

Groupe mis à jour

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

pageId

string

ID de la page dans laquelle se trouve le groupe

sectionId

string

ID de la section dans laquelle se trouve le groupe

groupId

string

ID du groupe

removeFromSectionId

string

ID de la section à partir de laquelle supprimer le groupe

Retours

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Mises à jour type d’élément de travail par défaut pour le comportement du processus.

function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>

Paramètres

processId

string

ID du processus

witRefNameForBehaviors

string

Nom de référence du type d’élément de travail pour le comportement

Retours

updateField(FieldUpdate, string)

Mises à jour un champ donné dans le processus.

function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>

Paramètres

field
FieldUpdate
processId

string

ID du processus

Retours

Promise<FieldModel>

updateList(PickListModel, string)

Mises à jour une liste.

function updateList(picklist: PickListModel, listId: string): Promise<PickListModel>

Paramètres

picklist
PickListModel
listId

string

ID de la liste

Retours

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Mises à jour une définition d’état donnée dans le type d’élément de travail du processus.

function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Paramètres

processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

stateId

string

ID de l’état

Retours

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Mises à jour un type d’élément de travail du processus.

function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>

Paramètres

workItemTypeUpdate
WorkItemTypeUpdateModel
processId

string

ID du processus

witRefName

string

Nom de référence du type d’élément de travail

Retours

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Mises à jour un seul champ dans l’étendue du processus et du type d’élément de travail donnés.

function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

Paramètres

field
WorkItemTypeFieldModel2

Modèle avec lequel mettre à jour le champ

processId

string

ID du processus

witRefNameForFields

string

Nom de référence du type d’élément de travail pour les champs

Retours