WorkItemTrackingProcessDefinitionsRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Agrega un comportamiento al tipo de elemento de trabajo del proceso.
addControlToGroup(Control, string, string, string)	Crea un control en un grupo
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Agrega un campo al tipo de elemento de trabajo en el proceso.
addGroup(Group, string, string, string, string)	Agrega un grupo al formulario de elemento de trabajo
addPage(Page, string, string)	Agrega una página al formulario de elemento de trabajo
createBehavior(BehaviorCreateModel, string)	Crea un único comportamiento en el proceso dado.
createField(FieldModel, string)	Crea un único campo en el proceso.
createList(PickListModel)	Crea una lista de selección.
createStateDefinition(WorkItemStateInputModel, string, string)	Crea una definición de estado en el tipo de elemento de trabajo del proceso.
createWorkItemType(WorkItemTypeModel, string)	Crea un tipo de elemento de trabajo en el proceso.
deleteBehavior(string, string)	Elimina un comportamiento en el proceso.
deleteList(string)	Elimina una lista de selección.
deleteStateDefinition(string, string, string)	Quita una definición de estado en el tipo de elemento de trabajo del proceso.
deleteWorkItemType(string, string)	Quita un tipo de elemento de trabajo en el proceso.
editControl(Control, string, string, string, string)	Actualiza un control en el formulario de elemento de trabajo
editGroup(Group, string, string, string, string, string)	Actualiza un grupo en el formulario de elemento de trabajo
editPage(Page, string, string)	Actualiza una página en el formulario de elemento de trabajo
getBehavior(string, string)	Devuelve un único comportamiento en el proceso.
getBehaviorForWorkItemType(string, string, string)	Devuelve un comportamiento para el tipo de elemento de trabajo del proceso.
getBehaviors(string)	Devuelve una lista de todos los comportamientos del proceso.
getBehaviorsForWorkItemType(string, string)	Devuelve una lista de todos los comportamientos para el tipo de elemento de trabajo del proceso.
getFormLayout(string, string)	Obtiene el diseño del formulario
getList(string)	Devuelve una lista de selección.
getListsMetadata()	Devuelve metadatos de la lista de selección.
getStateDefinition(string, string, string)	Devuelve una definición de estado en el tipo de elemento de trabajo del proceso.
getStateDefinitions(string, string)	Devuelve una lista de todas las definiciones de estado en el tipo de elemento de trabajo del proceso.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Devuelve un tipo de elemento de trabajo del proceso.
getWorkItemTypeField(string, string, string)	Devuelve un único campo en el tipo de elemento de trabajo del proceso.
getWorkItemTypeFields(string, string)	Devuelve una lista de todos los campos del tipo de elemento de trabajo del proceso.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Devuelve una lista de todos los tipos de elementos de trabajo del proceso.
hideStateDefinition(HideStateModel, string, string, string)	Oculta una definición de estado en el tipo de elemento de trabajo del proceso.
removeBehaviorFromWorkItemType(string, string, string)	Quita un comportamiento para el tipo de elemento de trabajo del proceso.
removeControlFromGroup(string, string, string, string)	Quita un control del formulario de elemento de trabajo
removeFieldFromWorkItemType(string, string, string)	Quita un campo en el tipo de elemento de trabajo del proceso.
removeGroup(string, string, string, string, string)	Quita un grupo del formulario de elemento de trabajo
removePage(string, string, string)	Quita una página del formulario de elemento de trabajo
replaceBehavior(BehaviorReplaceModel, string, string)	Reemplaza un comportamiento en el proceso.
setControlInGroup(Control, string, string, string, string, string)	Mueve un control a un nuevo grupo
setGroupInPage(Group, string, string, string, string, string, string, string)	Mueve un grupo a una página y sección diferente
setGroupInSection(Group, string, string, string, string, string, string)	Mueve un grupo a una sección diferente
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Actualiza el tipo de elemento de trabajo predeterminado para el comportamiento del proceso.
updateField(FieldUpdate, string)	Actualiza un campo determinado en el proceso.
updateList(PickListModel, string)	Actualiza una lista.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Actualiza una definición de estado determinada en el tipo de elemento de trabajo del proceso.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Actualiza un tipo de elemento de trabajo del proceso.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Actualiza un único campo en el ámbito del proceso y el tipo de elemento de trabajo especificados.

Detalles del constructor

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Agrega un comportamiento al tipo de elemento de trabajo del proceso.

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

Parámetros

behavior

WorkItemTypeBehavior

processId

string

Identificador del proceso

witRefNameForBehaviors

string

Nombre de referencia del tipo de elemento de trabajo para el comportamiento

Devoluciones

Promise<WorkItemTypeBehavior>

addControlToGroup(Control, string, string, string)

Crea un control en un grupo

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

Parámetros

control

Control

El control

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

groupId

string

El identificador del grupo al que se va a agregar el control

Devoluciones

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Agrega un campo al tipo de elemento de trabajo en el proceso.

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

Parámetros

field

WorkItemTypeFieldModel2

processId

string

Identificador del proceso

witRefNameForFields

string

Nombre de referencia del tipo de elemento de trabajo para el campo

Devoluciones

Promise<WorkItemTypeFieldModel2>

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

Agrega un grupo al formulario de elemento de trabajo

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

Parámetros

group

Group

El grupo

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

pageId

string

El ID de la página a la que se va a agregar el grupo

sectionId

string

El ID de la sección a la que se va a agregar el grupo

Devoluciones

Promise<Group>

addPage(Page, string, string)

Agrega una página al formulario de elemento de trabajo

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

Parámetros

page

Page

La página

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<Page>

createBehavior(BehaviorCreateModel, string)

Crea un único comportamiento en el proceso dado.

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

Parámetros

behavior

BehaviorCreateModel

processId

string

Identificador del proceso

Devoluciones

Promise<BehaviorModel>

createField(FieldModel, string)

Crea un único campo en el proceso.

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

Parámetros

field

FieldModel

processId

string

Identificador del proceso

Devoluciones

Promise<FieldModel>

createList(PickListModel)

Crea una lista de selección.

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

Parámetros

picklist

PickListModel

Devoluciones

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

Crea una definición de estado en el tipo de elemento de trabajo del proceso.

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

Parámetros

stateModel

WorkItemStateInputModel

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

Crea un tipo de elemento de trabajo en el proceso.

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

Parámetros

workItemType

WorkItemTypeModel

processId

string

Identificador del proceso

Devoluciones

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Elimina un comportamiento en el proceso.

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

Parámetros

processId

string

Identificador del proceso

behaviorId

string

El ID del comportamiento

Devoluciones

Promise<void>

deleteList(string)

Elimina una lista de selección.

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

Parámetros

listId

string

El ID de la lista

Devoluciones

Promise<void>

deleteStateDefinition(string, string, string)

Quita una definición de estado en el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Id. del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

stateId

string

ID del estado

Devoluciones

Promise<void>

deleteWorkItemType(string, string)

Quita un tipo de elemento de trabajo en el proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<void>

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

Actualiza un control en el formulario de elemento de trabajo

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

Parámetros

control

Control

El control actualizado

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

groupId

string

El ID del grupo

controlId

string

El identificador del control

Devoluciones

Promise<Control>

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

Actualiza un grupo en el formulario de elemento de trabajo

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

Parámetros

group

Group

El grupo actualizado

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

pageId

string

El ID de la página en la que se encuentra el grupo

sectionId

string

El ID de la sección en la que se encuentra el grupo

groupId

string

El ID del grupo

Devoluciones

Promise<Group>

editPage(Page, string, string)

Actualiza una página en el formulario de elemento de trabajo

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

Parámetros

page

Page

La página

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<Page>

getBehavior(string, string)

Devuelve un único comportamiento en el proceso.

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

Parámetros

processId

string

Identificador del proceso

behaviorId

string

El ID del comportamiento

Devoluciones

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

Devuelve un comportamiento para el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefNameForBehaviors

string

Nombre de referencia del tipo de elemento de trabajo para el comportamiento

behaviorRefName

string

El nombre de referencia del comportamiento

Devoluciones

Promise<WorkItemTypeBehavior>

getBehaviors(string)

Devuelve una lista de todos los comportamientos del proceso.

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

Parámetros

processId

string

Identificador del proceso

Devoluciones

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

Devuelve una lista de todos los comportamientos para el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefNameForBehaviors

string

Nombre de referencia del tipo de elemento de trabajo para el comportamiento

Devoluciones

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Obtiene el diseño del formulario

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<FormLayout>

getList(string)

Devuelve una lista de selección.

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

Parámetros

listId

string

El ID de la lista

Devoluciones

Promise<PickListModel>

getListsMetadata()

Devuelve metadatos de la lista de selección.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Devoluciones

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

Devuelve una definición de estado en el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

stateId

string

El ID del estado

Devoluciones

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Devuelve una lista de todas las definiciones de estado en el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<WorkItemStateResultModel[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Devuelve un tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

expand

GetWorkItemTypeExpand

Devoluciones

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Devuelve un único campo en el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefNameForFields

string

Nombre de referencia del tipo de elemento de trabajo para los campos

fieldRefName

string

El nombre de referencia del campo

Devoluciones

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

Devuelve una lista de todos los campos del tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefNameForFields

string

Nombre de referencia del tipo de elemento de trabajo para los campos

Devoluciones

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

Devuelve una lista de todos los tipos de elementos de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

expand

GetWorkItemTypeExpand

Devoluciones

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

Oculta una definición de estado en el tipo de elemento de trabajo del proceso.

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

Parámetros

hideStateModel

HideStateModel

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

stateId

string

El ID del estado

Devoluciones

Promise<WorkItemStateResultModel>

removeBehaviorFromWorkItemType(string, string, string)

Quita un comportamiento para el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefNameForBehaviors

string

Nombre de referencia del tipo de elemento de trabajo para el comportamiento

behaviorRefName

string

El nombre de referencia del comportamiento

Devoluciones

Promise<void>

removeControlFromGroup(string, string, string, string)

Quita un control del formulario de elemento de trabajo

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

groupId

string

El ID del grupo

controlId

string

El identificador del control que se va a quitar

Devoluciones

Promise<void>

removeFieldFromWorkItemType(string, string, string)

Quita un campo en el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

Identificador del proceso

witRefNameForFields

string

Nombre de referencia del tipo de elemento de trabajo para los campos

fieldRefName

string

El nombre de referencia del campo

Devoluciones

Promise<void>

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

Quita un grupo del formulario de elemento de trabajo

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

pageId

string

El ID de la página en la que se encuentra el grupo

sectionId

string

El ID de la sección del grupo está en

groupId

string

El ID del grupo

Devoluciones

Promise<void>

removePage(string, string, string)

Quita una página del formulario de elemento de trabajo

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

Parámetros

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

pageId

string

El ID de la página

Devoluciones

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

Reemplaza un comportamiento en el proceso.

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

Parámetros

behaviorData

BehaviorReplaceModel

processId

string

Identificador del proceso

behaviorId

string

El ID del comportamiento

Devoluciones

Promise<BehaviorModel>

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

Mueve un control a un nuevo grupo

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

Parámetros

control

Control

El control

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

groupId

string

El identificador del grupo al que se va a mover el control

controlId

string

El identificador del control

removeFromGroupId

string

El grupo del que se va a quitar el control

Devoluciones

Promise<Control>

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

Mueve un grupo a una página y sección diferente

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

Parámetros

group

Group

El grupo actualizado

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

pageId

string

El ID de la página en la que se encuentra el grupo

sectionId

string

El ID de la sección en la que se encuentra el grupo

groupId

string

El ID del grupo

removeFromPageId

string

ID de la página de la que se va a eliminar el grupo

removeFromSectionId

string

ID de la sección de la que se va a eliminar el grupo

Devoluciones

Promise<Group>

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

Mueve un grupo a una sección diferente

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

Parámetros

group

Group

El grupo actualizado

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

pageId

string

El ID de la página en la que se encuentra el grupo

sectionId

string

El ID de la sección en la que se encuentra el grupo

groupId

string

El ID del grupo

removeFromSectionId

string

ID de la sección de la que se va a eliminar el grupo

Devoluciones

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Actualiza el tipo de elemento de trabajo predeterminado para el comportamiento del proceso.

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

Parámetros

behavior

WorkItemTypeBehavior

processId

string

Identificador del proceso

witRefNameForBehaviors

string

Nombre de referencia del tipo de elemento de trabajo para el comportamiento

Devoluciones

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

Actualiza un campo determinado en el proceso.

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

Parámetros

field

FieldUpdate

processId

string

Identificador del proceso

Devoluciones

Promise<FieldModel>

updateList(PickListModel, string)

Actualiza una lista.

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

Parámetros

picklist

PickListModel

listId

string

El ID de la lista

Devoluciones

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Actualiza una definición de estado determinada en el tipo de elemento de trabajo del proceso.

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

Parámetros

stateModel

WorkItemStateInputModel

processId

string

Id. del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

stateId

string

ID del estado

Devoluciones

Promise<WorkItemStateResultModel>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Actualiza un tipo de elemento de trabajo del proceso.

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

Parámetros

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

Identificador del proceso

witRefName

string

El nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Actualiza un único campo en el ámbito del proceso y el tipo de elemento de trabajo especificados.

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

Parámetros

field

WorkItemTypeFieldModel2

El modelo con el que se va a actualizar el campo

processId

string

Identificador del proceso

witRefNameForFields

string

Nombre de referencia del tipo de elemento de trabajo para los campos

Devoluciones

Promise<WorkItemTypeFieldModel2>