WorkItemTrackingProcessDefinitionsRestClient class

Pacchetto:

azure-devops-extension-api

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

Extends

RestClientBase

Costruttori

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aggiunge un comportamento al tipo di elemento di lavoro del processo.
addControlToGroup(Control, string, string, string)	Crea un controllo in un gruppo
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Aggiunge un campo al tipo di elemento di lavoro nel processo.
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
createBehavior(BehaviorCreateModel, string)	Crea un singolo comportamento nel processo specificato.
createField(FieldModel, string)	Crea un singolo campo nel processo.
createList(PickListModel)	Crea un elenco di selezione.
createStateDefinition(WorkItemStateInputModel, string, string)	Crea una definizione di stato nel tipo di elemento di lavoro del processo.
createWorkItemType(WorkItemTypeModel, string)	Crea un tipo di elemento di lavoro nel processo.
deleteBehavior(string, string)	Rimuove un comportamento nel processo.
deleteList(string)	Rimuove un elenco di selezione.
deleteStateDefinition(string, string, string)	Rimuove una definizione di stato nel tipo di elemento di lavoro del processo.
deleteWorkItemType(string, string)	Rimuove un tipo di elemento di lavoro nel processo.
editControl(Control, string, string, string, string)	Aggiornamenti un controllo nel modulo dell'elemento di lavoro
editGroup(Group, string, string, string, string, string)	Aggiornamenti un gruppo nel modulo dell'elemento di lavoro
editPage(Page, string, string)	Aggiornamenti una pagina nel modulo dell'elemento di lavoro
getBehavior(string, string)	Restituisce un singolo comportamento nel processo.
getBehaviorForWorkItemType(string, string, string)	Restituisce un comportamento per il tipo di elemento di lavoro del processo.
getBehaviors(string)	Restituisce un elenco di tutti i comportamenti nel 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.
getListsMetadata()	Restituisce i metadati dell'elenco di selezione.
getStateDefinition(string, string, string)	Restituisce una definizione di stato nel tipo di elemento di lavoro del processo.
getStateDefinitions(string, string)	Restituisce un elenco di tutte le definizioni di stato nel tipo di elemento di lavoro del processo.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Restituisce un tipo di elemento di lavoro del processo.
getWorkItemTypeField(string, string, string)	Restituisce un singolo campo nel tipo di elemento di lavoro del processo.
getWorkItemTypeFields(string, string)	Restituisce un elenco di tutti i campi nel tipo di elemento di lavoro del processo.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Restituisce un elenco di tutti i tipi di elemento di lavoro nel processo.
hideStateDefinition(HideStateModel, string, string, string)	Nasconde una definizione di stato nel tipo di elemento di lavoro del processo.
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
removeFieldFromWorkItemType(string, string, string)	Rimuove un campo nel tipo di elemento di lavoro del processo.
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
replaceBehavior(BehaviorReplaceModel, string, string)	Sostituisce un comportamento nel processo.
setControlInGroup(Control, string, string, string, string, string)	Sposta un controllo in un nuovo gruppo
setGroupInPage(Group, string, string, string, string, string, string, string)	Sposta un gruppo in una pagina e una sezione diversa
setGroupInSection(Group, string, string, string, string, string, string)	Sposta un gruppo in una sezione diversa
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aggiornamenti tipo di elemento di lavoro predefinito per il comportamento del processo.
updateField(FieldUpdate, string)	Aggiornamenti un determinato campo nel processo.
updateList(PickListModel, string)	Aggiornamenti un elenco.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Aggiornamenti una definizione di stato specificata nel tipo di elemento di lavoro del processo.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Aggiornamenti un tipo di elemento di lavoro del processo.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Aggiornamenti un singolo campo nell'ambito del tipo di elemento di lavoro e del processo specificato.

Dettagli costruttore

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(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>

addControlToGroup(Control, string, string, string)

Crea un controllo in un gruppo

function addControlToGroup(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 da aggiungere al controllo

Restituisce

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Aggiunge un campo al tipo di elemento di lavoro nel processo.

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

Parametri

field

WorkItemTypeFieldModel2

processId

string

ID del processo

witRefNameForFields

string

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

Restituisce

Promise<WorkItemTypeFieldModel2>

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 da aggiungere al 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>

createBehavior(BehaviorCreateModel, string)

Crea un singolo comportamento nel processo specificato.

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

Parametri

behavior

BehaviorCreateModel

processId

string

ID del processo

Restituisce

Promise<BehaviorModel>

createField(FieldModel, string)

Crea un singolo campo nel processo.

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

Parametri

field

FieldModel

processId

string

ID del processo

Restituisce

Promise<FieldModel>

createList(PickListModel)

Crea un elenco di selezione.

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

Parametri

picklist

PickListModel

Restituisce

Promise<PickListModel>

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>

createWorkItemType(WorkItemTypeModel, string)

Crea un tipo di elemento di lavoro nel processo.

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

Parametri

workItemType

WorkItemTypeModel

processId

string

ID del processo

Restituisce

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Rimuove un comportamento nel processo.

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

Parametri

processId

string

ID del processo

behaviorId

string

ID del comportamento

Restituisce

Promise<void>

deleteList(string)

Rimuove un elenco di selezione.

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

Parametri

listId

string

ID dell'elenco

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>

deleteWorkItemType(string, string)

Rimuove un tipo di elemento di lavoro nel processo.

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

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

Aggiornamenti un controllo nel modulo dell'elemento di lavoro

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

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

Aggiornamenti un gruppo nel modulo dell'elemento di lavoro

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

editPage(Page, string, string)

Aggiornamenti una pagina nel modulo dell'elemento di lavoro

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

getBehavior(string, string)

Restituisce un singolo comportamento nel processo.

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

Parametri

processId

string

ID del processo

behaviorId

string

ID del comportamento

Restituisce

Promise<BehaviorModel>

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>

getBehaviors(string)

Restituisce un elenco di tutti i comportamenti nel processo.

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

Parametri

processId

string

ID del processo

Restituisce

Promise<BehaviorModel[]>

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

Parametri

listId

string

ID dell'elenco

Restituisce

Promise<PickListModel>

getListsMetadata()

Restituisce i metadati dell'elenco di selezione.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Restituisce

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

Restituisce una definizione di stato nel 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 nel 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[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Restituisce un tipo di elemento di lavoro del processo.

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

Parametri

processId

string

ID del processo

witRefName

string

Nome di riferimento del tipo di elemento di lavoro

expand

GetWorkItemTypeExpand

Restituisce

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Restituisce un singolo campo nel tipo di elemento di lavoro del processo.

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

Parametri

processId

string

ID del processo

witRefNameForFields

string

Nome di riferimento del tipo di elemento di lavoro per i campi

fieldRefName

string

Nome di riferimento del campo

Restituisce

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

Restituisce un elenco di tutti i campi nel tipo di elemento di lavoro del processo.

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

Parametri

processId

string

ID del processo

witRefNameForFields

string

Nome di riferimento del tipo di elemento di lavoro per i campi

Restituisce

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

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

Parametri

processId

string

ID del processo

expand

GetWorkItemTypeExpand

Restituisce

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

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

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>

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>

removeFieldFromWorkItemType(string, string, string)

Rimuove un campo nel tipo di elemento di lavoro del processo.

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

Parametri

processId

string

ID del processo

witRefNameForFields

string

Nome di riferimento del tipo di elemento di lavoro per i campi

fieldRefName

string

Nome di riferimento del campo

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>

replaceBehavior(BehaviorReplaceModel, string, string)

Sostituisce un comportamento nel processo.

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

Parametri

behaviorData

BehaviorReplaceModel

processId

string

ID del processo

behaviorId

string

ID del comportamento

Restituisce

Promise<BehaviorModel>

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

Sposta un controllo in un nuovo gruppo

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

Gruppo da cui rimuovere il controllo

Restituisce

Promise<Control>

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

Sposta un gruppo in una pagina e una sezione diversa

function setGroupInPage(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 in cui si trova il gruppo

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>

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

Sposta un gruppo in una sezione diversa

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

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aggiornamenti tipo di elemento di lavoro predefinito per il comportamento 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>

updateField(FieldUpdate, string)

Aggiornamenti un determinato campo nel processo.

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

Parametri

field

FieldUpdate

processId

string

ID del processo

Restituisce

Promise<FieldModel>

updateList(PickListModel, string)

Aggiornamenti un elenco.

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

Parametri

picklist

PickListModel

listId

string

ID dell'elenco

Restituisce

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Aggiornamenti una definizione di stato specificata 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>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Aggiornamenti un tipo di elemento di lavoro del processo.

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

Parametri

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

ID del processo

witRefName

string

Nome di riferimento del tipo di elemento di lavoro

Restituisce

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Aggiornamenti un singolo campo nell'ambito del tipo di elemento di lavoro e del processo specificato.

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

Parametri

field

WorkItemTypeFieldModel2

Modello con cui aggiornare il campo

processId

string

ID del processo

witRefNameForFields

string

Nome di riferimento del tipo di elemento di lavoro per i campi

Restituisce

Promise<WorkItemTypeFieldModel2>