WorkItemTrackingProcessRestClient 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

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Agrega un comportamiento al tipo de elemento de trabajo del proceso.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Agrega un campo a un tipo de elemento de trabajo.
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.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Agrega una regla al tipo de elemento de trabajo en el proceso.
createControlInGroup(Control, string, string, string)	Crea un control en un grupo.
createList(PickList)	Crea una lista desplegable.
createNewProcess(CreateProcessModel)	Crea un proceso.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Crea un único comportamiento en el proceso especificado.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Crea un tipo de elemento de trabajo en el proceso.
createStateDefinition(WorkItemStateInputModel, string, string)	Crea una definición de estado en el tipo de elemento de trabajo del proceso.
deleteList(string)	Quita una lista desplegable.
deleteProcessBehavior(string, string)	Quita un comportamiento en el proceso.
deleteProcessById(string)	Quita un proceso de un identificador específico.
deleteProcessWorkItemType(string, string)	Quita un tipo de elemento de trabajo en el proceso.
deleteProcessWorkItemTypeRule(string, string, string)	Quita una regla del tipo de elemento de trabajo en el proceso.
deleteStateDefinition(string, string, string)	Quita una definición de estado en el tipo de elemento de trabajo del proceso.
deleteSystemControl(string, string, string)	Elimina una modificación del control del sistema en el formulario de elemento de trabajo.
editProcess(UpdateProcessModel, string)	Edite un proceso de un identificador específico.
getAllWorkItemTypeFields(string, string)	Devuelve una lista de todos los campos de un tipo de elemento de trabajo.
getBehaviorForWorkItemType(string, string, string)	Devuelve un comportamiento para el tipo de elemento de trabajo del proceso.
getBehaviorsForWorkItemType(string, string)	Devuelve una lista de todos los comportamientos del tipo de elemento de trabajo del proceso.
getFormLayout(string, string)	Obtiene el diseño del formulario.
getList(string)	Devuelve una lista desplegable.
getListOfProcesses(GetProcessExpandLevel)	Obtenga una lista de todos los procesos, incluidos el sistema y heredados.
getListsMetadata()	Devuelve metadatos de la lista de selección.
getProcessBehavior(string, string, GetBehaviorsExpand)	Devuelve un comportamiento del proceso.
getProcessBehaviors(string, GetBehaviorsExpand)	Devuelve una lista de todos los comportamientos del proceso.
getProcessByItsId(string, GetProcessExpandLevel)	Obtiene un único proceso de un identificador especificado.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Devuelve un único tipo de elemento de trabajo en un proceso.
getProcessWorkItemTypeRule(string, string, string)	Devuelve una sola regla en el tipo de elemento de trabajo del proceso.
getProcessWorkItemTypeRules(string, string)	Devuelve una lista de todas las reglas del tipo de elemento de trabajo del proceso.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Devuelve una lista de todos los tipos de elementos de trabajo de un proceso.
getStateDefinition(string, string, string)	Devuelve una única definición de estado en un tipo de elemento de trabajo del proceso.
getStateDefinitions(string, string)	Devuelve una lista de todas las definiciones de estado de un tipo de elemento de trabajo del proceso.
getSystemControls(string, string)	Obtiene controles del sistema editados para un tipo de elemento de trabajo en un proceso. Para obtener todos los controles del sistema (base y editados), use las API de diseño.
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Devuelve un campo en un tipo de elemento de trabajo.
hideStateDefinition(HideStateModel, string, string, string)	Oculta una definición de estado en el tipo de elemento de trabajo del proceso. Solo se pueden ocultar los estados con customizationType:System.
moveControlToGroup(Control, string, string, string, string, string)	Mueve un control a un grupo especificado.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Mueve un grupo a otra página y sección.
moveGroupToSection(Group, string, string, string, string, string, string)	Mueve un grupo a otra sección.
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.
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.
removeWorkItemTypeField(string, string, string)	Quita un campo de un tipo de elemento de trabajo. No elimina permanentemente el campo.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Novedades un comportamiento para el tipo de elemento de trabajo del proceso.
updateControl(Control, string, string, string, string)	Novedades un control en el formulario de elemento de trabajo.
updateGroup(Group, string, string, string, string, string)	Novedades un grupo en el formulario de elemento de trabajo.
updateList(PickList, string)	Novedades una lista.
updatePage(Page, string, string)	Novedades una página del formulario de elemento de trabajo
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Reemplaza un comportamiento en el proceso.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Novedades un tipo de elemento de trabajo del proceso.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Novedades una regla en el tipo de elemento de trabajo del proceso.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Novedades una definición de estado determinada en el tipo de elemento de trabajo del proceso.
updateSystemControl(Control, string, string, string)	Novedades/agrega un control del sistema en el formulario de elemento de trabajo.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Novedades un campo en un tipo de elemento de trabajo.

Detalles del constructor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

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

El identificador del proceso

witRefNameForBehaviors

string

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

Devoluciones

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Agrega un campo a un tipo de elemento de trabajo.

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

Parámetros

field

AddProcessWorkItemTypeFieldRequest

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

Devoluciones

Promise<ProcessWorkItemTypeField>

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

Nombre de referencia del tipo de elemento de trabajo.

pageId

string

Identificador de la página a la que se va a agregar el grupo.

sectionId

string

Identificador 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

Página.

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

Devoluciones

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Agrega una regla al tipo de elemento de trabajo en el proceso.

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

Parámetros

processRuleCreate

CreateProcessRuleRequest

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Crea un control en un grupo.

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

Parámetros

control

Control

Control.

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

groupId

string

Identificador del grupo al que se va a agregar el control.

Devoluciones

Promise<Control>

createList(PickList)

Crea una lista desplegable.

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

Parámetros

picklist

PickList

Lista desplegable

Devoluciones

Promise<PickList>

createNewProcess(CreateProcessModel)

Crea un proceso.

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

Parámetros

createRequest

CreateProcessModel

CreateProcessModel.

Devoluciones

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Crea un único comportamiento en el proceso especificado.

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

Parámetros

behavior

ProcessBehaviorCreateRequest

processId

string

El identificador del proceso

Devoluciones

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Crea un tipo de elemento de trabajo en el proceso.

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

Parámetros

workItemType

CreateProcessWorkItemTypeRequest

processId

string

Identificador del proceso en el que se va a crear el tipo de elemento de trabajo.

Devoluciones

Promise<ProcessWorkItemType>

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

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<WorkItemStateResultModel>

deleteList(string)

Quita una lista desplegable.

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

Parámetros

listId

string

Identificador de la lista

Devoluciones

Promise<void>

deleteProcessBehavior(string, string)

Quita un comportamiento en el proceso.

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

Parámetros

processId

string

El identificador del proceso

behaviorRefName

string

Nombre de referencia del comportamiento

Devoluciones

Promise<void>

deleteProcessById(string)

Quita un proceso de un identificador específico.

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

Parámetros

processTypeId

string

Devoluciones

Promise<void>

deleteProcessWorkItemType(string, string)

Quita un tipo de elemento de trabajo en el proceso.

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

Parámetros

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

Devoluciones

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Quita una regla del tipo de elemento de trabajo en el proceso.

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

Parámetros

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

ruleId

string

El identificador de la regla

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

Nombre de referencia del tipo de elemento de trabajo

stateId

string

Identificador del estado

Devoluciones

Promise<void>

deleteSystemControl(string, string, string)

Elimina una modificación del control del sistema en el formulario de elemento de trabajo.

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

Parámetros

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

controlId

string

Id. del control.

Devoluciones

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Edite un proceso de un identificador específico.

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

Parámetros

updateRequest

UpdateProcessModel

processTypeId

string

Devoluciones

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Devuelve una lista de todos los campos de un tipo de elemento de trabajo.

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

Parámetros

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

Devoluciones

Promise<ProcessWorkItemTypeField[]>

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

El identificador del proceso

witRefNameForBehaviors

string

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

behaviorRefName

string

Nombre de referencia del comportamiento

Devoluciones

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

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

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

Parámetros

processId

string

El 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

Nombre de referencia del tipo de elemento de trabajo.

Devoluciones

Promise<FormLayout>

getList(string)

Devuelve una lista desplegable.

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

Parámetros

listId

string

Identificador de la lista

Devoluciones

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Obtenga una lista de todos los procesos, incluidos el sistema y heredados.

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

Parámetros

expand

GetProcessExpandLevel

Devoluciones

Promise<ProcessInfo[]>

getListsMetadata()

Devuelve metadatos de la lista de selección.

function getListsMetadata(): Promise<PickListMetadata[]>

Devoluciones

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Devuelve un comportamiento del proceso.

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

Parámetros

processId

string

El identificador del proceso

behaviorRefName

string

Nombre de referencia del comportamiento

expand

GetBehaviorsExpand

Devoluciones

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Devuelve una lista de todos los comportamientos del proceso.

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

Parámetros

processId

string

El identificador del proceso

expand

GetBehaviorsExpand

Devoluciones

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Obtiene un único proceso de un identificador especificado.

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

Parámetros

processTypeId

string

expand

GetProcessExpandLevel

Devoluciones

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Devuelve un único tipo de elemento de trabajo en un proceso.

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

Parámetros

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

expand

GetWorkItemTypeExpand

Marca para determinar qué propiedades del tipo de elemento de trabajo se va a devolver

Devoluciones

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Devuelve una sola regla en el tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

ruleId

string

El identificador de la regla

Devoluciones

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Devuelve una lista de todas las reglas del tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

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

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

Parámetros

processId

string

El identificador del proceso

expand

GetWorkItemTypeExpand

Marca para determinar qué propiedades del tipo de elemento de trabajo se va a devolver

Devoluciones

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Devuelve una única definición de estado en un tipo de elemento de trabajo del proceso.

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

Parámetros

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

stateId

string

El identificador del estado

Devoluciones

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

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

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

Parámetros

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Obtiene controles del sistema editados para un tipo de elemento de trabajo en un proceso. Para obtener todos los controles del sistema (base y editados), use las API de diseño.

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

Parámetros

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

Devoluciones

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Devuelve un campo en un tipo de elemento de trabajo.

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

Parámetros

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

fieldRefName

string

Nombre de referencia del campo.

expand

ProcessWorkItemTypeFieldsExpandLevel

Devoluciones

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Oculta una definición de estado en el tipo de elemento de trabajo del proceso. Solo se pueden ocultar los estados con customizationType:System.

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

Parámetros

hideStateModel

HideStateModel

processId

string

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

stateId

string

El identificador del estado

Devoluciones

Promise<WorkItemStateResultModel>

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

Mueve un control a un grupo especificado.

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

Parámetros

control

Control

Control.

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

groupId

string

Identificador del grupo al que se va a mover el control.

controlId

string

Id. del control.

removeFromGroupId

string

Identificador de grupo del que se va a quitar el control.

Devoluciones

Promise<Control>

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

Mueve un grupo a otra página y sección.

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

Nombre de referencia del tipo de elemento de trabajo.

pageId

string

Identificador de la página en la que se encuentra el grupo.

sectionId

string

El identificador de la sección que el grupo es i.n

groupId

string

Identificador del grupo.

removeFromPageId

string

Identificador de la página de la que se va a quitar el grupo.

removeFromSectionId

string

Id. de la sección de la que se va a quitar el grupo.

Devoluciones

Promise<Group>

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

Mueve un grupo a otra sección.

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

Nombre de referencia del tipo de elemento de trabajo.

pageId

string

Identificador de la página en la que se encuentra el grupo.

sectionId

string

Identificador de la sección en la que se encuentra el grupo.

groupId

string

Identificador del grupo.

removeFromSectionId

string

Id. de la sección de la que se va a quitar el grupo.

Devoluciones

Promise<Group>

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

El identificador del proceso

witRefNameForBehaviors

string

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

behaviorRefName

string

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

Nombre de referencia del tipo de elemento de trabajo.

groupId

string

Identificador del grupo.

controlId

string

Identificador del control que se va a quitar.

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

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

pageId

string

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

sectionId

string

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

groupId

string

El identificador 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

El identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

pageId

string

Identificador de la página

Devoluciones

Promise<void>

removeWorkItemTypeField(string, string, string)

Quita un campo de un tipo de elemento de trabajo. No elimina permanentemente el campo.

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

Parámetros

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

fieldRefName

string

Nombre de referencia del campo.

Devoluciones

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

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

Parámetros

behavior

WorkItemTypeBehavior

processId

string

El identificador del proceso

witRefNameForBehaviors

string

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

Devoluciones

Promise<WorkItemTypeBehavior>

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

Novedades un control en el formulario de elemento de trabajo.

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

Parámetros

control

Control

Control actualizado.

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

groupId

string

Identificador del grupo.

controlId

string

Id. del control.

Devoluciones

Promise<Control>

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

Novedades un grupo en el formulario de elemento de trabajo.

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

Nombre de referencia del tipo de elemento de trabajo.

pageId

string

Identificador de la página en la que se encuentra el grupo.

sectionId

string

Identificador de la sección en la que se encuentra el grupo.

groupId

string

Identificador del grupo.

Devoluciones

Promise<Group>

updateList(PickList, string)

Novedades una lista.

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

Parámetros

picklist

PickList

listId

string

Identificador de la lista

Devoluciones

Promise<PickList>

updatePage(Page, string, string)

Novedades una página del formulario de elemento de trabajo

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

Parámetros

page

Page

Página

processId

string

Identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Reemplaza un comportamiento en el proceso.

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

Parámetros

behaviorData

ProcessBehaviorUpdateRequest

processId

string

Identificador del proceso

behaviorRefName

string

Nombre de referencia del comportamiento

Devoluciones

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Novedades un tipo de elemento de trabajo del proceso.

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

Parámetros

workItemTypeUpdate

UpdateProcessWorkItemTypeRequest

processId

string

Identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

Devoluciones

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Novedades una regla en el tipo de elemento de trabajo del proceso.

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

Parámetros

processRule

UpdateProcessRuleRequest

processId

string

Identificador del proceso

witRefName

string

Nombre de referencia del tipo de elemento de trabajo

ruleId

string

El identificador de la regla

Devoluciones

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Novedades 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

Nombre de referencia del tipo de elemento de trabajo

stateId

string

Identificador del estado

Devoluciones

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Novedades/agrega un control del sistema en el formulario de elemento de trabajo.

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

Parámetros

control

Control

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

controlId

string

Id. del control.

Devoluciones

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Novedades un campo en un tipo de elemento de trabajo.

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

Parámetros

field

UpdateProcessWorkItemTypeFieldRequest

processId

string

Identificador del proceso.

witRefName

string

Nombre de referencia del tipo de elemento de trabajo.

fieldRefName

string

Nombre de referencia del campo.

Devoluciones

Promise<ProcessWorkItemTypeField>