WorkItemTrackingProcessRestClient class

Référence

Paquet:: azure-devops-extension-api

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

Extends: RestClientBase

Constructeurs

WorkItemTrackingProcessRestClient(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.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Ajoute un champ à un type d’élément de travail.
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.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Ajoute une règle au type d’élément de travail dans le processus.
createControlInGroup(Control, string, string, string)	Crée un contrôle dans un groupe.
createList(PickList)	Crée une liste de choix.
createNewProcess(CreateProcessModel)	Crée un processus.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Crée un seul comportement dans le processus donné.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Crée un type d’élément de travail dans le processus.
createStateDefinition(WorkItemStateInputModel, string, string)	Crée une définition d’état dans le type d’élément de travail du processus.
deleteList(string)	Supprime une liste de choix.
deleteProcessBehavior(string, string)	Supprime un comportement dans le processus.
deleteProcessById(string)	Supprime un processus d’un ID spécifique.
deleteProcessWorkItemType(string, string)	Supprime un type d’élément de travail dans le processus.
deleteProcessWorkItemTypeRule(string, string, string)	Supprime une règle du type d’élément de travail dans le processus.
deleteStateDefinition(string, string, string)	Supprime une définition d’état dans le type d’élément de travail du processus.
deleteSystemControl(string, string, string)	Supprime une modification de contrôle système dans le formulaire d’élément de travail.
editProcess(UpdateProcessModel, string)	Modifier un processus d’un ID spécifique.
getAllWorkItemTypeFields(string, string)	Retourne une liste de tous les champs d’un type d’élément de travail.
getBehaviorForWorkItemType(string, string, string)	Retourne un comportement pour le type d’élément de travail 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.
getListOfProcesses(GetProcessExpandLevel)	Obtenez la liste de tous les processus, y compris le système et les processus hérités.
getListsMetadata()	Retourne les métadonnées de la liste de sélection.
getProcessBehavior(string, string, GetBehaviorsExpand)	Retourne un comportement du processus.
getProcessBehaviors(string, GetBehaviorsExpand)	Retourne une liste de tous les comportements du processus.
getProcessByItsId(string, GetProcessExpandLevel)	Obtenez un processus unique d’un ID spécifié.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Retourne un seul type d’élément de travail dans un processus.
getProcessWorkItemTypeRule(string, string, string)	Retourne une règle unique dans le type d’élément de travail du processus.
getProcessWorkItemTypeRules(string, string)	Retourne une liste de toutes les règles du type d’élément de travail du processus.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Retourne une liste de tous les types d’éléments de travail d’un processus.
getStateDefinition(string, string, string)	Retourne une définition d’état unique dans un type d’élément de travail du processus.
getStateDefinitions(string, string)	Retourne la liste de toutes les définitions d’état dans un type d’élément de travail du processus.
getSystemControls(string, string)	Obtient des contrôles système modifiés pour un type d’élément de travail dans un processus. Pour obtenir tous les contrôles système (base + modifiés) utilisez la ou les API de disposition
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Retourne un champ dans un type d’élément de travail.
hideStateDefinition(HideStateModel, string, string, string)	Masque une définition d’état dans le type d’élément de travail du processus. Seuls les états avec customType:System peuvent être masqués.
moveControlToGroup(Control, string, string, string, string, string)	Déplace un contrôle vers un groupe spécifié.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Déplace un groupe vers une autre page et une autre section.
moveGroupToSection(Group, string, string, string, string, string, string)	Déplace un groupe vers une autre section.
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.
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
removeWorkItemTypeField(string, string, string)	Supprime un champ d’un type d’élément de travail. Ne supprime pas définitivement le champ.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Mises à jour un comportement pour le type d’élément de travail du processus.
updateControl(Control, string, string, string, string)	Mises à jour un contrôle sur le formulaire d’élément de travail.
updateGroup(Group, string, string, string, string, string)	Mises à jour un groupe dans le formulaire élément de travail.
updateList(PickList, string)	Mises à jour une liste.
updatePage(Page, string, string)	Mises à jour une page dans le formulaire d’élément de travail
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Remplace un comportement dans le processus.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Mises à jour un type d’élément de travail du processus.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Mises à jour une règle dans le type d’élément de travail du processus.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Mises à jour une définition d’état donnée dans le type d’élément de travail du processus.
updateSystemControl(Control, string, string, string)	Mises à jour/ajoute un contrôle système sur le formulaire d’élément de travail.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Mises à jour un champ dans un type d’élément de travail.

Détails du constructeur

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

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

behavior: WorkItemTypeBehavior

processId: string

ID du processus

witRefNameForBehaviors: string

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

Retours

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Ajoute un champ à un type d’élément de travail.

function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>

Paramètres

field: AddProcessWorkItemTypeFieldRequest

processId: string

ID du processus.

witRefName: string

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

Retours

Promise<ProcessWorkItemTypeField>

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

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

Page.

processId: string

ID du processus.

witRefName: string

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

Retours

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Ajoute une règle au type d’élément de travail dans le processus.

function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>

Paramètres

processRuleCreate: CreateProcessRuleRequest

processId: string

ID du processus

witRefName: string

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

Retours

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Crée un contrôle dans un groupe.

function createControlInGroup(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>

createList(PickList)

Crée une liste de choix.

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

Paramètres

picklist: PickList

Liste déroulante

Retours

Promise<PickList>

createNewProcess(CreateProcessModel)

Crée un processus.

function createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>

Paramètres

createRequest: CreateProcessModel

CreateProcessModel.

Retours

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

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

function createProcessBehavior(behavior: ProcessBehaviorCreateRequest, processId: string): Promise<ProcessBehavior>

Paramètres

behavior: ProcessBehaviorCreateRequest

processId: string

ID du processus

Retours

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

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

function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>

Paramètres

workItemType: CreateProcessWorkItemTypeRequest

processId: string

ID du processus sur lequel créer le type d’élément de travail.

Retours

Promise<ProcessWorkItemType>

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

stateModel: WorkItemStateInputModel

processId: string

ID du processus

witRefName: string

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

Retours

Promise<WorkItemStateResultModel>

deleteList(string)

Supprime une liste de choix.

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

Paramètres

listId: string

ID de la liste

Retours

Promise<void>

deleteProcessBehavior(string, string)

Supprime un comportement dans le processus.

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

Paramètres

processId: string

ID du processus

behaviorRefName: string

Nom de référence du comportement

Retours

Promise<void>

deleteProcessById(string)

Supprime un processus d’un ID spécifique.

function deleteProcessById(processTypeId: string): Promise<void>

Paramètres

processTypeId: string

Retours

Promise<void>

deleteProcessWorkItemType(string, string)

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

function deleteProcessWorkItemType(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>

deleteProcessWorkItemTypeRule(string, string, string)

Supprime une règle du type d’élément de travail dans le processus.

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

Paramètres

processId: string

ID du processus

witRefName: string

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

ruleId: string

ID de la règle

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>

deleteSystemControl(string, string, string)

Supprime une modification de contrôle système dans le formulaire d’élément de travail.

function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>

Paramètres

processId: string

ID du processus.

witRefName: string

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

controlId: string

L'ID du contrôle.

Retours

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Modifier un processus d’un ID spécifique.

function editProcess(updateRequest: UpdateProcessModel, processTypeId: string): Promise<ProcessInfo>

Paramètres

updateRequest: UpdateProcessModel

processTypeId: string

Retours

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Retourne une liste de tous les champs d’un type d’élément de travail.

function getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<ProcessWorkItemTypeField[]>

Paramètres

processId: string

ID du processus.

witRefName: string

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

Retours

Promise<ProcessWorkItemTypeField[]>

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

Promise<WorkItemTypeBehavior>

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

Promise<WorkItemTypeBehavior[]>

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<PickList>

Paramètres

listId: string

ID de la liste

Retours

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Obtenez la liste de tous les processus, y compris le système et les processus hérités.

function getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>

Paramètres

expand: GetProcessExpandLevel

Retours

Promise<ProcessInfo[]>

getListsMetadata()

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

function getListsMetadata(): Promise<PickListMetadata[]>

Retours

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Retourne un comportement du processus.

function getProcessBehavior(processId: string, behaviorRefName: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior>

Paramètres

processId: string

ID du processus

behaviorRefName: string

Nom de référence du comportement

expand: GetBehaviorsExpand

Retours

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Retourne une liste de tous les comportements du processus.

function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>

Paramètres

processId: string

ID du processus

expand: GetBehaviorsExpand

Retours

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Obtenez un processus unique d’un ID spécifié.

function getProcessByItsId(processTypeId: string, expand?: GetProcessExpandLevel): Promise<ProcessInfo>

Paramètres

processTypeId: string

expand: GetProcessExpandLevel

Retours

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

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

function getProcessWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType>

Paramètres

processId: string

ID du processus

witRefName: string

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

expand: GetWorkItemTypeExpand

Indicateur pour déterminer les propriétés du type d’élément de travail à retourner

Retours

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Retourne une règle unique dans le type d’élément de travail du processus.

function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>

Paramètres

processId: string

ID du processus

witRefName: string

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

ruleId: string

ID de la règle

Retours

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Retourne une liste de toutes les règles du type d’élément de travail du processus.

function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>

Paramètres

processId: string

ID du processus

witRefName: string

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

Retours

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

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

function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>

Paramètres

processId: string

ID du processus

expand: GetWorkItemTypeExpand

Indicateur pour déterminer les propriétés du type d’élément de travail à retourner

Retours

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Retourne une définition d’état unique dans un 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

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Retourne la liste de toutes les définitions d’état dans un 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

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Obtient des contrôles système modifiés pour un type d’élément de travail dans un processus. Pour obtenir tous les contrôles système (base + modifiés) utilisez la ou les API de disposition

function getSystemControls(processId: string, witRefName: string): Promise<Control[]>

Paramètres

processId: string

ID du processus.

witRefName: string

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

Retours

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Retourne un champ dans un type d’élément de travail.

function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>

Paramètres

processId: string

ID du processus.

witRefName: string

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

fieldRefName: string

Nom de référence du champ.

expand: ProcessWorkItemTypeFieldsExpandLevel

Retours

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Masque une définition d’état dans le type d’élément de travail du processus. Seuls les états avec customType:System peuvent être masqués.

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

Promise<WorkItemStateResultModel>

moveControlToGroup(Control, string, string, string, string, string)

Déplace un contrôle vers un groupe spécifié.

function moveControlToGroup(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

L'ID du contrôle.

removeFromGroupId: string

ID de groupe à partir duquel supprimer le contrôle.

Retours

Promise<Control>

moveGroupToPage(Group, string, string, string, string, string, string, string)

Déplace un groupe vers une autre page et une autre section.

function moveGroupToPage(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 dont le groupe est i.n

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>

moveGroupToSection(Group, string, string, string, string, string, string)

Déplace un groupe vers une autre section.

function moveGroupToSection(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>

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>

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>

removeWorkItemTypeField(string, string, string)

Supprime un champ d’un type d’élément de travail. Ne supprime pas définitivement le champ.

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

Paramètres

processId: string

ID du processus.

witRefName: string

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

fieldRefName: string

Nom de référence du champ.

Retours

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

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

Paramètres

behavior: WorkItemTypeBehavior

processId: string

ID du processus

witRefNameForBehaviors: string

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

Retours

Promise<WorkItemTypeBehavior>

updateControl(Control, string, string, string, string)

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

function updateControl(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

L'ID du contrôle.

Retours

Promise<Control>

updateGroup(Group, string, string, string, string, string)

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

function updateGroup(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>

updateList(PickList, string)

Mises à jour une liste.

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

Paramètres

picklist: PickList

listId: string

ID de la liste

Retours

Promise<PickList>

updatePage(Page, string, string)

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

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

Paramètres

page: Page

Page

processId: string

ID du processus

witRefName: string

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

Retours

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Remplace un comportement dans le processus.

function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>

Paramètres

behaviorData: ProcessBehaviorUpdateRequest

processId: string

ID du processus

behaviorRefName: string

Nom de référence du comportement

Retours

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

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

function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>

Paramètres

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

ID du processus

witRefName: string

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

Retours

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Mises à jour une règle dans le type d’élément de travail du processus.

function updateProcessWorkItemTypeRule(processRule: UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>

Paramètres

processRule: UpdateProcessRuleRequest

processId: string

ID du processus

witRefName: string

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

ruleId: string

ID de la règle

Retours

Promise<ProcessRule>

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

stateModel: WorkItemStateInputModel

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<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Mises à jour/ajoute un contrôle système sur le formulaire d’élément de travail.

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

Paramètres

control: Control

processId: string

ID du processus.

witRefName: string

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

controlId: string

L'ID du contrôle.

Retours

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Mises à jour un champ dans un type d’élément de travail.

function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>

Paramètres

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

ID du processus.

witRefName: string

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

fieldRefName: string

Nom de référence du champ.

Retours

Promise<ProcessWorkItemTypeField>

Partager via

WorkItemTrackingProcessRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Paramètres

Retours

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Paramètres

Retours

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

Paramètres

Retours

addPage(Page, string, string)

Paramètres

Retours

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Paramètres

Retours

createControlInGroup(Control, string, string, string)

Paramètres

Retours

createList(PickList)

Paramètres

Retours

createNewProcess(CreateProcessModel)

Paramètres

Retours

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Paramètres

Retours

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Paramètres

Retours

createStateDefinition(WorkItemStateInputModel, string, string)

Paramètres

Retours

deleteList(string)

Paramètres

Retours

deleteProcessBehavior(string, string)

Paramètres

Retours

deleteProcessById(string)

Paramètres

Retours

deleteProcessWorkItemType(string, string)

Paramètres

Retours

deleteProcessWorkItemTypeRule(string, string, string)

Paramètres

Retours

deleteStateDefinition(string, string, string)

Paramètres

Retours

deleteSystemControl(string, string, string)

Paramètres

Retours

editProcess(UpdateProcessModel, string)

Paramètres

Retours

getAllWorkItemTypeFields(string, string)

Paramètres

Retours

getBehaviorForWorkItemType(string, string, string)

Paramètres

Retours

getBehaviorsForWorkItemType(string, string)

Paramètres

Retours

getFormLayout(string, string)

Paramètres