WorkItemTrackingProcessRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends: RestClientBase

Costruttori

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aggiunge un comportamento al tipo di elemento di lavoro del processo.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Aggiunge un campo a un tipo di elemento di lavoro.
addGroup(Group, string, string, string, string)	Aggiunge un gruppo al modulo dell'elemento di lavoro.
addPage(Page, string, string)	Aggiunge una pagina al modulo dell'elemento di lavoro.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Aggiunge una regola al tipo di elemento di lavoro nel processo.
createControlInGroup(Control, string, string, string)	Crea un controllo in un gruppo.
createList(PickList)	Crea un elenco di selezione.
createNewProcess(CreateProcessModel)	Crea un processo.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Crea un singolo comportamento nel processo specificato.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Crea un tipo di elemento di lavoro nel processo.
createStateDefinition(WorkItemStateInputModel, string, string)	Crea una definizione di stato nel tipo di elemento di lavoro del processo.
deleteList(string)	Rimuove un elenco di selezione.
deleteProcessBehavior(string, string)	Rimuove un comportamento nel processo.
deleteProcessById(string)	Rimuove un processo di un ID specifico.
deleteProcessWorkItemType(string, string)	Rimuove un tipo di elemento di lavoro nel processo.
deleteProcessWorkItemTypeRule(string, string, string)	Rimuove una regola dal tipo di elemento di lavoro nel processo.
deleteStateDefinition(string, string, string)	Rimuove una definizione di stato nel tipo di elemento di lavoro del processo.
deleteSystemControl(string, string, string)	Elimina una modifica del controllo di sistema nel modulo dell'elemento di lavoro.
editProcess(UpdateProcessModel, string)	Modificare un processo di un ID specifico.
getAllWorkItemTypeFields(string, string)	Restituisce un elenco di tutti i campi in un tipo di elemento di lavoro.
getBehaviorForWorkItemType(string, string, string)	Restituisce un comportamento per il tipo di elemento di lavoro del processo.
getBehaviorsForWorkItemType(string, string)	Restituisce un elenco di tutti i comportamenti per il tipo di elemento di lavoro del processo.
getFormLayout(string, string)	Ottiene il layout del modulo.
getList(string)	Restituisce un elenco di selezione.
getListOfProcesses(GetProcessExpandLevel)	Ottenere l'elenco di tutti i processi, inclusi il sistema e ereditati.
getListsMetadata()	Restituisce i metadati dell'elenco di selezione.
getProcessBehavior(string, string, GetBehaviorsExpand)	Restituisce un comportamento del processo.
getProcessBehaviors(string, GetBehaviorsExpand)	Restituisce un elenco di tutti i comportamenti nel processo.
getProcessByItsId(string, GetProcessExpandLevel)	Ottenere un singolo processo di un ID specificato.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Restituisce un singolo tipo di elemento di lavoro in un processo.
getProcessWorkItemTypeRule(string, string, string)	Restituisce una singola regola nel tipo di elemento di lavoro del processo.
getProcessWorkItemTypeRules(string, string)	Restituisce un elenco di tutte le regole nel tipo di elemento di lavoro del processo.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Restituisce un elenco di tutti i tipi di elemento di lavoro in un processo.
getStateDefinition(string, string, string)	Restituisce una singola definizione di stato in un tipo di elemento di lavoro del processo.
getStateDefinitions(string, string)	Restituisce un elenco di tutte le definizioni di stato in un tipo di elemento di lavoro del processo.
getSystemControls(string, string)	Ottiene i controlli di sistema modificati per un tipo di elemento di lavoro in un processo. Per ottenere tutti i controlli di sistema (base e modificata) usare api di layout
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Restituisce un campo in un tipo di elemento di lavoro.
hideStateDefinition(HideStateModel, string, string, string)	Nasconde una definizione di stato nel tipo di elemento di lavoro del processo. È possibile nascondere solo gli stati con personalizzazioneType:System.
moveControlToGroup(Control, string, string, string, string, string)	Sposta un controllo in un gruppo specificato.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Sposta un gruppo in una pagina e una sezione diversa.
moveGroupToSection(Group, string, string, string, string, string, string)	Sposta un gruppo in una sezione diversa.
removeBehaviorFromWorkItemType(string, string, string)	Rimuove un comportamento per il tipo di elemento di lavoro del processo.
removeControlFromGroup(string, string, string, string)	Rimuove un controllo dal modulo dell'elemento di lavoro.
removeGroup(string, string, string, string, string)	Rimuove un gruppo dal modulo dell'elemento di lavoro.
removePage(string, string, string)	Rimuove una pagina dal modulo dell'elemento di lavoro
removeWorkItemTypeField(string, string, string)	Rimuove un campo da un tipo di elemento di lavoro. Non elimina definitivamente il campo.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aggiornamenti un comportamento per il tipo di elemento di lavoro del processo.
updateControl(Control, string, string, string, string)	Aggiornamenti un controllo nel modulo dell'elemento di lavoro.
updateGroup(Group, string, string, string, string, string)	Aggiornamenti un gruppo nel modulo dell'elemento di lavoro.
updateList(PickList, string)	Aggiornamenti un elenco.
updatePage(Page, string, string)	Aggiornamenti una pagina nel modulo dell'elemento di lavoro
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Sostituisce un comportamento nel processo.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Aggiornamenti un tipo di elemento di lavoro del processo.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Aggiornamenti una regola nel tipo di elemento di lavoro del processo.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Aggiornamenti una determinata definizione di stato nel tipo di elemento di lavoro del processo.
updateSystemControl(Control, string, string, string)	Aggiornamenti/aggiunge un controllo di sistema nel modulo dell'elemento di lavoro.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Aggiornamenti un campo in un tipo di elemento di lavoro.

Dettagli costruttore

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aggiunge un comportamento al tipo di elemento di lavoro del processo.

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

Parametri

behavior: WorkItemTypeBehavior

processId: string

ID del processo

witRefNameForBehaviors: string

Nome di riferimento del tipo di elemento di lavoro per il comportamento

Restituisce

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Aggiunge un campo a un tipo di elemento di lavoro.

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

Parametri

field: AddProcessWorkItemTypeFieldRequest

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

Restituisce

Promise<ProcessWorkItemTypeField>

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

Aggiunge un gruppo al modulo dell'elemento di lavoro.

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

Parametri

group: Group

Gruppo.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

pageId: string

ID della pagina da aggiungere al gruppo.

sectionId: string

ID della sezione a cui aggiungere il gruppo.

Restituisce

Promise<Group>

addPage(Page, string, string)

Aggiunge una pagina al modulo dell'elemento di lavoro.

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

Parametri

page: Page

Pagina.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

Restituisce

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Aggiunge una regola al tipo di elemento di lavoro nel processo.

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

Parametri

processRuleCreate: CreateProcessRuleRequest

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Crea un controllo in un gruppo.

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

Parametri

control: Control

Controllo.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

groupId: string

ID del gruppo a cui aggiungere il controllo.

Restituisce

Promise<Control>

createList(PickList)

Crea un elenco di selezione.

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

Parametri

picklist: PickList

Elenco a discesa

Restituisce

Promise<PickList>

createNewProcess(CreateProcessModel)

Crea un processo.

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

Parametri

createRequest: CreateProcessModel

CreateProcessModel.

Restituisce

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Crea un singolo comportamento nel processo specificato.

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

Parametri

behavior: ProcessBehaviorCreateRequest

processId: string

ID del processo

Restituisce

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Crea un tipo di elemento di lavoro nel processo.

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

Parametri

workItemType: CreateProcessWorkItemTypeRequest

processId: string

ID del processo in cui creare il tipo di elemento di lavoro.

Restituisce

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

Crea una definizione di stato nel tipo di elemento di lavoro del processo.

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

Parametri

stateModel: WorkItemStateInputModel

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<WorkItemStateResultModel>

deleteList(string)

Rimuove un elenco di selezione.

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

Parametri

listId: string

ID dell'elenco

Restituisce

Promise<void>

deleteProcessBehavior(string, string)

Rimuove un comportamento nel processo.

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

Parametri

processId: string

ID del processo

behaviorRefName: string

Nome di riferimento del comportamento

Restituisce

Promise<void>

deleteProcessById(string)

Rimuove un processo di un ID specifico.

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

Parametri

processTypeId: string

Restituisce

Promise<void>

deleteProcessWorkItemType(string, string)

Rimuove un tipo di elemento di lavoro nel processo.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

Restituisce

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Rimuove una regola dal tipo di elemento di lavoro nel processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

ruleId: string

ID della regola

Restituisce

Promise<void>

deleteStateDefinition(string, string, string)

Rimuove una definizione di stato nel tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

stateId: string

ID dello stato

Restituisce

Promise<void>

deleteSystemControl(string, string, string)

Elimina una modifica del controllo di sistema nel modulo dell'elemento di lavoro.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

controlId: string

ID del controllo.

Restituisce

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Modificare un processo di un ID specifico.

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

Parametri

updateRequest: UpdateProcessModel

processTypeId: string

Restituisce

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Restituisce un elenco di tutti i campi in un tipo di elemento di lavoro.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

Restituisce

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Restituisce un comportamento per il tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefNameForBehaviors: string

Nome di riferimento del tipo di elemento di lavoro per il comportamento

behaviorRefName: string

Nome di riferimento del comportamento

Restituisce

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Restituisce un elenco di tutti i comportamenti per il tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefNameForBehaviors: string

Nome di riferimento del tipo di elemento di lavoro per il comportamento

Restituisce

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Ottiene il layout del modulo.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

Restituisce

Promise<FormLayout>

getList(string)

Restituisce un elenco di selezione.

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

Parametri

listId: string

ID dell'elenco

Restituisce

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Ottenere l'elenco di tutti i processi, inclusi il sistema e ereditati.

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

Parametri

expand: GetProcessExpandLevel

Restituisce

Promise<ProcessInfo[]>

getListsMetadata()

Restituisce i metadati dell'elenco di selezione.

function getListsMetadata(): Promise<PickListMetadata[]>

Restituisce

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Restituisce un comportamento del processo.

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

Parametri

processId: string

ID del processo

behaviorRefName: string

Nome di riferimento del comportamento

expand: GetBehaviorsExpand

Restituisce

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Restituisce un elenco di tutti i comportamenti nel processo.

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

Parametri

processId: string

ID del processo

expand: GetBehaviorsExpand

Restituisce

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Ottenere un singolo processo di un ID specificato.

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

Parametri

processTypeId: string

expand: GetProcessExpandLevel

Restituisce

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Restituisce un singolo tipo di elemento di lavoro in un processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

expand: GetWorkItemTypeExpand

Contrassegno per determinare le proprietà del tipo di elemento di lavoro da restituire

Restituisce

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Restituisce una singola regola nel tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

ruleId: string

ID della regola

Restituisce

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Restituisce un elenco di tutte le regole nel tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Restituisce un elenco di tutti i tipi di elemento di lavoro in un processo.

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

Parametri

processId: string

ID del processo

expand: GetWorkItemTypeExpand

Contrassegno per determinare le proprietà del tipo di elemento di lavoro da restituire

Restituisce

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Restituisce una singola definizione di stato in un tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

stateId: string

ID dello stato

Restituisce

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Restituisce un elenco di tutte le definizioni di stato in un tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Ottiene i controlli di sistema modificati per un tipo di elemento di lavoro in un processo. Per ottenere tutti i controlli di sistema (base e modificata) usare api di layout

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

Restituisce

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Restituisce un campo in un tipo di elemento di lavoro.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

fieldRefName: string

Nome di riferimento del campo.

expand: ProcessWorkItemTypeFieldsExpandLevel

Restituisce

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Nasconde una definizione di stato nel tipo di elemento di lavoro del processo. È possibile nascondere solo gli stati con personalizzazioneType:System.

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

Parametri

hideStateModel: HideStateModel

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

stateId: string

ID dello stato

Restituisce

Promise<WorkItemStateResultModel>

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

Sposta un controllo in un gruppo specificato.

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

Parametri

control: Control

Controllo.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

groupId: string

ID del gruppo in cui spostare il controllo.

controlId: string

ID del controllo.

removeFromGroupId: string

ID gruppo da cui rimuovere il controllo.

Restituisce

Promise<Control>

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

Sposta un gruppo in una pagina e una sezione diversa.

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

Parametri

group: Group

Gruppo aggiornato.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

pageId: string

ID della pagina in cui si trova il gruppo.

sectionId: string

ID della sezione il gruppo è i.n

groupId: string

ID del gruppo.

removeFromPageId: string

ID della pagina da cui rimuovere il gruppo.

removeFromSectionId: string

ID della sezione da cui rimuovere il gruppo.

Restituisce

Promise<Group>

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

Sposta un gruppo in una sezione diversa.

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

Parametri

group: Group

Gruppo aggiornato.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

pageId: string

ID della pagina in cui si trova il gruppo.

sectionId: string

ID della sezione in cui si trova il gruppo.

groupId: string

ID del gruppo.

removeFromSectionId: string

ID della sezione da cui rimuovere il gruppo.

Restituisce

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

Rimuove un comportamento per il tipo di elemento di lavoro del processo.

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

Parametri

processId: string

ID del processo

witRefNameForBehaviors: string

Nome di riferimento del tipo di elemento di lavoro per il comportamento

behaviorRefName: string

Nome di riferimento del comportamento

Restituisce

Promise<void>

removeControlFromGroup(string, string, string, string)

Rimuove un controllo dal modulo dell'elemento di lavoro.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

groupId: string

ID del gruppo.

controlId: string

ID del controllo da rimuovere.

Restituisce

Promise<void>

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

Rimuove un gruppo dal modulo dell'elemento di lavoro.

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

pageId: string

ID della pagina in cui si trova il gruppo

sectionId: string

L'ID della sezione del gruppo è in

groupId: string

ID del gruppo

Restituisce

Promise<void>

removePage(string, string, string)

Rimuove una pagina dal modulo dell'elemento di lavoro

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

Parametri

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

pageId: string

ID della pagina

Restituisce

Promise<void>

removeWorkItemTypeField(string, string, string)

Rimuove un campo da un tipo di elemento di lavoro. Non elimina definitivamente il campo.

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

Parametri

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

fieldRefName: string

Nome di riferimento del campo.

Restituisce

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aggiornamenti un comportamento per il tipo di elemento di lavoro del processo.

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

Parametri

behavior: WorkItemTypeBehavior

processId: string

ID del processo

witRefNameForBehaviors: string

Nome di riferimento del tipo di elemento di lavoro per il comportamento

Restituisce

Promise<WorkItemTypeBehavior>

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

Aggiornamenti un controllo nel modulo dell'elemento di lavoro.

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

Parametri

control: Control

Controllo aggiornato.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

groupId: string

ID del gruppo.

controlId: string

ID del controllo.

Restituisce

Promise<Control>

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

Aggiornamenti un gruppo nel modulo dell'elemento di lavoro.

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

Parametri

group: Group

Gruppo aggiornato.

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

pageId: string

ID della pagina in cui si trova il gruppo.

sectionId: string

ID della sezione in cui si trova il gruppo.

groupId: string

ID del gruppo.

Restituisce

Promise<Group>

updateList(PickList, string)

Aggiornamenti un elenco.

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

Parametri

picklist: PickList

listId: string

ID dell'elenco

Restituisce

Promise<PickList>

updatePage(Page, string, string)

Aggiornamenti una pagina nel modulo dell'elemento di lavoro

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

Parametri

page: Page

Pagina

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Sostituisce un comportamento nel processo.

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

Parametri

behaviorData: ProcessBehaviorUpdateRequest

processId: string

ID del processo

behaviorRefName: string

Nome di riferimento del comportamento

Restituisce

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Aggiornamenti un tipo di elemento di lavoro del processo.

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

Parametri

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Aggiornamenti una regola nel tipo di elemento di lavoro del processo.

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

Parametri

processRule: UpdateProcessRuleRequest

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

ruleId: string

ID della regola

Restituisce

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Aggiornamenti una determinata definizione di stato nel tipo di elemento di lavoro del processo.

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

Parametri

stateModel: WorkItemStateInputModel

processId: string

ID del processo

witRefName: string

Nome di riferimento del tipo di elemento di lavoro

stateId: string

ID dello stato

Restituisce

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Aggiornamenti/aggiunge un controllo di sistema nel modulo dell'elemento di lavoro.

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

Parametri

control: Control

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

controlId: string

ID del controllo.

Restituisce

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Aggiornamenti un campo in un tipo di elemento di lavoro.

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

Parametri

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

ID del processo.

witRefName: string

Nome di riferimento del tipo di elemento di lavoro.

fieldRefName: string

Nome di riferimento del campo.

Restituisce

Promise<ProcessWorkItemTypeField>

Condividi tramite

WorkItemTrackingProcessRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Parametri

Restituisce

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Parametri

Restituisce

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

Parametri

Restituisce

addPage(Page, string, string)

Parametri

Restituisce

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Parametri

Restituisce

createControlInGroup(Control, string, string, string)

Parametri

Restituisce

createList(PickList)

Parametri

Restituisce

createNewProcess(CreateProcessModel)

Parametri

Restituisce

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Parametri

Restituisce

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Parametri

Restituisce

createStateDefinition(WorkItemStateInputModel, string, string)

Parametri

Restituisce

deleteList(string)

Parametri

Restituisce

deleteProcessBehavior(string, string)

Parametri

Restituisce

deleteProcessById(string)

Parametri

Restituisce

deleteProcessWorkItemType(string, string)

Parametri

Restituisce

deleteProcessWorkItemTypeRule(string, string, string)

Parametri

Restituisce

deleteStateDefinition(string, string, string)

Parametri

Restituisce

deleteSystemControl(string, string, string)

Parametri

Restituisce

editProcess(UpdateProcessModel, string)

Parametri

Restituisce

getAllWorkItemTypeFields(string, string)

Parametri

Restituisce

getBehaviorForWorkItemType(string, string, string)

Parametri

Restituisce

getBehaviorsForWorkItemType(string, string)

Parametri

Restituisce

getFormLayout(string, string)

Parametri