WorkItemTrackingProcessRestClient class

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Paramètres

static RESOURCE_AREA_ID: string

Valeur de propriété

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

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

Crée un contrôle dans un groupe.

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

Paramètres

Retours

Crée une liste de choix.

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

Paramètres

Retours

Crée un processus.

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

Paramètres

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

Supprime une liste de choix.

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

Paramètres

Retours

Supprime un comportement dans le processus.

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

Paramètres

Retours

Supprime un processus d’un ID spécifique.

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

Modifier un processus d’un ID spécifique.

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

Obtient la disposition du formulaire.

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

Paramètres

Retours

Retourne une liste de choix.

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

Paramètres

Retours

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

Retours

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

function getListsMetadata(): Promise<PickListMetadata[]>

Retours

Retourne un comportement du processus.

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

Paramètres

Retours

Retourne une liste de tous les comportements du processus.

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

Paramètres

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

Mises à jour une liste.

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

Paramètres

Retours

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

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

Paramètres

Retours

Remplace un comportement dans le processus.

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours