WorkItemTrackingProcessRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends: RestClientBase

Construtores

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Adiciona um comportamento ao tipo de item de trabalho do processo.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Adiciona um campo a um tipo de item de trabalho.
addGroup(Group, string, string, string, string)	Adiciona um grupo ao formulário de item de trabalho.
addPage(Page, string, string)	Adiciona uma página ao formulário de item de trabalho.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Adiciona uma regra ao tipo de item de trabalho no processo.
createControlInGroup(Control, string, string, string)	Cria um controlo num grupo.
createList(PickList)	Cria uma lista de opções.
createNewProcess(CreateProcessModel)	Cria um processo.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Cria um único comportamento no processo especificado.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Cria um tipo de item de trabalho no processo.
createStateDefinition(WorkItemStateInputModel, string, string)	Cria uma definição de estado no tipo de item de trabalho do processo.
deleteList(string)	Remove uma lista de opções.
deleteProcessBehavior(string, string)	Remove um comportamento no processo.
deleteProcessById(string)	Remove um processo de um ID específico.
deleteProcessWorkItemType(string, string)	Remove um tipo de item de trabalho no processo.
deleteProcessWorkItemTypeRule(string, string, string)	Remove uma regra do tipo de item de trabalho no processo.
deleteStateDefinition(string, string, string)	Remove uma definição de estado no tipo de item de trabalho do processo.
deleteSystemControl(string, string, string)	Elimina uma modificação do controlo de sistema no formulário de item de trabalho.
editProcess(UpdateProcessModel, string)	Editar um processo de um ID específico.
getAllWorkItemTypeFields(string, string)	Devolve uma lista de todos os campos num tipo de item de trabalho.
getBehaviorForWorkItemType(string, string, string)	Devolve um comportamento para o tipo de item de trabalho do processo.
getBehaviorsForWorkItemType(string, string)	Devolve uma lista de todos os comportamentos do tipo de item de trabalho do processo.
getFormLayout(string, string)	Obtém o esquema de formulário.
getList(string)	Devolve uma lista de opções.
getListOfProcesses(GetProcessExpandLevel)	Obtenha uma lista de todos os processos, incluindo o sistema e herdado.
getListsMetadata()	Devolve metadados da lista de opções.
getProcessBehavior(string, string, GetBehaviorsExpand)	Devolve um comportamento do processo.
getProcessBehaviors(string, GetBehaviorsExpand)	Devolve uma lista de todos os comportamentos no processo.
getProcessByItsId(string, GetProcessExpandLevel)	Obtenha um único processo de um ID especificado.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Devolve um único tipo de item de trabalho num processo.
getProcessWorkItemTypeRule(string, string, string)	Devolve uma única regra no tipo de item de trabalho do processo.
getProcessWorkItemTypeRules(string, string)	Devolve uma lista de todas as regras no tipo de item de trabalho do processo.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Devolve uma lista de todos os tipos de itens de trabalho num processo.
getStateDefinition(string, string, string)	Devolve uma definição de estado único num tipo de item de trabalho do processo.
getStateDefinitions(string, string)	Devolve uma lista de todas as definições de estado num tipo de item de trabalho do processo.
getSystemControls(string, string)	Obtém controlos de sistema editados para um tipo de item de trabalho num processo. Para obter todos os controlos do sistema (base + editado) utilize a(s) API(s) de esquema
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Devolve um campo num tipo de item de trabalho.
hideStateDefinition(HideStateModel, string, string, string)	Oculta uma definição de estado no tipo de item de trabalho do processo. Apenas os estados com customizationType:System podem ser ocultados.
moveControlToGroup(Control, string, string, string, string, string)	Move um controlo para um grupo especificado.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Move um grupo para uma página e secção diferentes.
moveGroupToSection(Group, string, string, string, string, string, string)	Move um grupo para uma secção diferente.
removeBehaviorFromWorkItemType(string, string, string)	Remove um comportamento para o tipo de item de trabalho do processo.
removeControlFromGroup(string, string, string, string)	Remove um controlo do formulário do item de trabalho.
removeGroup(string, string, string, string, string)	Remove um grupo do formulário de item de trabalho.
removePage(string, string, string)	Remove uma página do formulário de item de trabalho
removeWorkItemTypeField(string, string, string)	Remove um campo de um tipo de item de trabalho. Não elimina permanentemente o campo.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Atualizações um comportamento para o tipo de item de trabalho do processo.
updateControl(Control, string, string, string, string)	Atualizações um controlo no formulário do item de trabalho.
updateGroup(Group, string, string, string, string, string)	Atualizações um grupo no formulário de item de trabalho.
updateList(PickList, string)	Atualizações uma lista.
updatePage(Page, string, string)	Atualizações uma página no formulário de item de trabalho
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Substitui um comportamento no processo.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Atualizações um tipo de item de trabalho do processo.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Atualizações uma regra no tipo de item de trabalho do processo.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Atualizações uma determinada definição de estado no tipo de item de trabalho do processo.
updateSystemControl(Control, string, string, string)	Atualizações/adiciona um controlo de sistema no formulário de item de trabalho.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Atualizações um campo num tipo de item de trabalho.

Detalhes do Construtor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Adiciona um comportamento ao tipo de item de trabalho do processo.

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

Parâmetros

behavior: WorkItemTypeBehavior

processId: string

O ID do processo

witRefNameForBehaviors: string

Nome de referência do tipo de item de trabalho para o comportamento

Devoluções

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Adiciona um campo a um tipo de item de trabalho.

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

Parâmetros

field: AddProcessWorkItemTypeFieldRequest

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

Devoluções

Promise<ProcessWorkItemTypeField>

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

Adiciona um grupo ao formulário de item de trabalho.

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

Parâmetros

group: Group

O grupo.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

pageId: string

O ID da página à qual adicionar o grupo.

sectionId: string

O ID da secção à qual adicionar o grupo.

Devoluções

Promise<Group>

addPage(Page, string, string)

Adiciona uma página ao formulário de item de trabalho.

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

Parâmetros

page: Page

A página.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

Devoluções

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Adiciona uma regra ao tipo de item de trabalho no processo.

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

Parâmetros

processRuleCreate: CreateProcessRuleRequest

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

Devoluções

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Cria um controlo num grupo.

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

Parâmetros

control: Control

O controlo.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

groupId: string

O ID do grupo ao qual adicionar o controlo.

Devoluções

Promise<Control>

createList(PickList)

Cria uma lista de opções.

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

Parâmetros

picklist: PickList

Picklist

Devoluções

Promise<PickList>

createNewProcess(CreateProcessModel)

Cria um processo.

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

Parâmetros

createRequest: CreateProcessModel

CreateProcessModel.

Devoluções

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Cria um único comportamento no processo especificado.

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

Parâmetros

behavior: ProcessBehaviorCreateRequest

processId: string

O ID do processo

Devoluções

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Cria um tipo de item de trabalho no processo.

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

Parâmetros

workItemType: CreateProcessWorkItemTypeRequest

processId: string

O ID do processo no qual criar o tipo de item de trabalho.

Devoluções

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

Cria uma definição de estado no tipo de item de trabalho do processo.

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

Parâmetros

stateModel: WorkItemStateInputModel

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

Devoluções

Promise<WorkItemStateResultModel>

deleteList(string)

Remove uma lista de opções.

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

Parâmetros

listId: string

O ID da lista

Devoluções

Promise<void>

deleteProcessBehavior(string, string)

Remove um comportamento no processo.

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

Parâmetros

processId: string

O ID do processo

behaviorRefName: string

O nome de referência do comportamento

Devoluções

Promise<void>

deleteProcessById(string)

Remove um processo de um ID específico.

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

Parâmetros

processTypeId: string

Devoluções

Promise<void>

deleteProcessWorkItemType(string, string)

Remove um tipo de item de trabalho no processo.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

Devoluções

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Remove uma regra do tipo de item de trabalho no processo.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

ruleId: string

O ID da regra

Devoluções

Promise<void>

deleteStateDefinition(string, string, string)

Remove uma definição de estado no tipo de item de trabalho do processo.

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

Parâmetros

processId: string

ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

stateId: string

ID do estado

Devoluções

Promise<void>

deleteSystemControl(string, string, string)

Elimina uma modificação do controlo de sistema no formulário de item de trabalho.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

controlId: string

O ID do controlo.

Devoluções

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Editar um processo de um ID específico.

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

Parâmetros

updateRequest: UpdateProcessModel

processTypeId: string

Devoluções

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Devolve uma lista de todos os campos num tipo de item de trabalho.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

Devoluções

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Devolve um comportamento para o tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefNameForBehaviors: string

Nome de referência do tipo de item de trabalho para o comportamento

behaviorRefName: string

O nome de referência do comportamento

Devoluções

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Devolve uma lista de todos os comportamentos do tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefNameForBehaviors: string

Nome de referência do tipo de item de trabalho para o comportamento

Devoluções

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Obtém o esquema de formulário.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

Devoluções

Promise<FormLayout>

getList(string)

Devolve uma lista de opções.

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

Parâmetros

listId: string

O ID da lista

Devoluções

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Obtenha uma lista de todos os processos, incluindo o sistema e herdado.

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

Parâmetros

expand: GetProcessExpandLevel

Devoluções

Promise<ProcessInfo[]>

getListsMetadata()

Devolve metadados da lista de opções.

function getListsMetadata(): Promise<PickListMetadata[]>

Devoluções

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Devolve um comportamento do processo.

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

Parâmetros

processId: string

O ID do processo

behaviorRefName: string

O nome de referência do comportamento

expand: GetBehaviorsExpand

Devoluções

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Devolve uma lista de todos os comportamentos no processo.

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

Parâmetros

processId: string

O ID do processo

expand: GetBehaviorsExpand

Devoluções

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Obtenha um único processo de um ID especificado.

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

Parâmetros

processTypeId: string

expand: GetProcessExpandLevel

Devoluções

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Devolve um único tipo de item de trabalho num processo.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

expand: GetWorkItemTypeExpand

Sinalizar para determinar as propriedades do tipo de item de trabalho a devolver

Devoluções

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Devolve uma única regra no tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

ruleId: string

O ID da regra

Devoluções

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Devolve uma lista de todas as regras no tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

Devoluções

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Devolve uma lista de todos os tipos de itens de trabalho num processo.

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

Parâmetros

processId: string

O ID do processo

expand: GetWorkItemTypeExpand

Sinalizar para determinar as propriedades do tipo de item de trabalho a devolver

Devoluções

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Devolve uma definição de estado único num tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

stateId: string

O ID do estado

Devoluções

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Devolve uma lista de todas as definições de estado num tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

Devoluções

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Obtém controlos de sistema editados para um tipo de item de trabalho num processo. Para obter todos os controlos do sistema (base + editado) utilize a(s) API(s) de esquema

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

Devoluções

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Devolve um campo num tipo de item de trabalho.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

fieldRefName: string

O nome de referência do campo.

expand: ProcessWorkItemTypeFieldsExpandLevel

Devoluções

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Oculta uma definição de estado no tipo de item de trabalho do processo. Apenas os estados com customizationType:System podem ser ocultados.

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

Parâmetros

hideStateModel: HideStateModel

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

stateId: string

O ID do estado

Devoluções

Promise<WorkItemStateResultModel>

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

Move um controlo para um grupo especificado.

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

Parâmetros

control: Control

O controlo.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

groupId: string

O ID do grupo para o qual mover o controlo.

controlId: string

O ID do controlo.

removeFromGroupId: string

O ID de grupo do qual remover o controlo.

Devoluções

Promise<Control>

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

Move um grupo para uma página e secção diferentes.

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

Parâmetros

group: Group

O grupo atualizado.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

pageId: string

O ID da página em que o grupo se encontra.

sectionId: string

O ID da secção em que o grupo é i.n

groupId: string

O ID do grupo.

removeFromPageId: string

ID da página da qual pretende remover o grupo.

removeFromSectionId: string

ID da secção da qual pretende remover o grupo.

Devoluções

Promise<Group>

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

Move um grupo para uma secção diferente.

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

Parâmetros

group: Group

O grupo atualizado.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

pageId: string

O ID da página em que o grupo se encontra.

sectionId: string

O ID da secção em que o grupo se encontra.

groupId: string

O ID do grupo.

removeFromSectionId: string

ID da secção da qual pretende remover o grupo.

Devoluções

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

Remove um comportamento para o tipo de item de trabalho do processo.

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

Parâmetros

processId: string

O ID do processo

witRefNameForBehaviors: string

Nome de referência do tipo de item de trabalho para o comportamento

behaviorRefName: string

O nome de referência do comportamento

Devoluções

Promise<void>

removeControlFromGroup(string, string, string, string)

Remove um controlo do formulário do item de trabalho.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

groupId: string

O ID do grupo.

controlId: string

O ID do controlo a remover.

Devoluções

Promise<void>

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

Remove um grupo do formulário de item de trabalho.

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

pageId: string

O ID da página em que o grupo se encontra

sectionId: string

O ID da secção para o grupo encontra-se em

groupId: string

O ID do grupo

Devoluções

Promise<void>

removePage(string, string, string)

Remove uma página do formulário de item de trabalho

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

Parâmetros

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

pageId: string

O ID da página

Devoluções

Promise<void>

removeWorkItemTypeField(string, string, string)

Remove um campo de um tipo de item de trabalho. Não elimina permanentemente o campo.

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

Parâmetros

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

fieldRefName: string

O nome de referência do campo.

Devoluções

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Atualizações um comportamento para o tipo de item de trabalho do processo.

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

Parâmetros

behavior: WorkItemTypeBehavior

processId: string

O ID do processo

witRefNameForBehaviors: string

Nome de referência do tipo de item de trabalho para o comportamento

Devoluções

Promise<WorkItemTypeBehavior>

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

Atualizações um controlo no formulário do item de trabalho.

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

Parâmetros

control: Control

O controlo atualizado.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

groupId: string

O ID do grupo.

controlId: string

O ID do controlo.

Devoluções

Promise<Control>

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

Atualizações um grupo no formulário de item de trabalho.

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

Parâmetros

group: Group

O grupo atualizado.

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

pageId: string

O ID da página em que o grupo se encontra.

sectionId: string

O ID da secção em que o grupo se encontra.

groupId: string

O ID do grupo.

Devoluções

Promise<Group>

updateList(PickList, string)

Atualizações uma lista.

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

Parâmetros

picklist: PickList

listId: string

O ID da lista

Devoluções

Promise<PickList>

updatePage(Page, string, string)

Atualizações uma página no formulário de item de trabalho

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

Parâmetros

page: Page

A página

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

Devoluções

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Substitui um comportamento no processo.

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

Parâmetros

behaviorData: ProcessBehaviorUpdateRequest

processId: string

O ID do processo

behaviorRefName: string

O nome de referência do comportamento

Devoluções

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Atualizações um tipo de item de trabalho do processo.

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

Parâmetros

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

Devoluções

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Atualizações uma regra no tipo de item de trabalho do processo.

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

Parâmetros

processRule: UpdateProcessRuleRequest

processId: string

O ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

ruleId: string

O ID da regra

Devoluções

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Atualizações uma determinada definição de estado no tipo de item de trabalho do processo.

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

Parâmetros

stateModel: WorkItemStateInputModel

processId: string

ID do processo

witRefName: string

O nome de referência do tipo de item de trabalho

stateId: string

ID do estado

Devoluções

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Atualizações/adiciona um controlo de sistema no formulário de item de trabalho.

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

Parâmetros

control: Control

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

controlId: string

O ID do controlo.

Devoluções

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Atualizações um campo num tipo de item de trabalho.

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

Parâmetros

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

O ID do processo.

witRefName: string

O nome de referência do tipo de item de trabalho.

fieldRefName: string

O nome de referência do campo.

Devoluções

Promise<ProcessWorkItemTypeField>

Partilhar via

WorkItemTrackingProcessRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Parâmetros

Devoluções

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

addPage(Page, string, string)

Parâmetros

Devoluções

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Parâmetros

Devoluções

createControlInGroup(Control, string, string, string)

Parâmetros

Devoluções

createList(PickList)

Parâmetros

Devoluções

createNewProcess(CreateProcessModel)

Parâmetros

Devoluções

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Parâmetros

Devoluções

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Parâmetros

Devoluções

createStateDefinition(WorkItemStateInputModel, string, string)

Parâmetros

Devoluções

deleteList(string)

Parâmetros

Devoluções

deleteProcessBehavior(string, string)

Parâmetros

Devoluções

deleteProcessById(string)

Parâmetros

Devoluções

deleteProcessWorkItemType(string, string)

Parâmetros

Devoluções

deleteProcessWorkItemTypeRule(string, string, string)

Parâmetros

Devoluções

deleteStateDefinition(string, string, string)

Parâmetros

Devoluções

deleteSystemControl(string, string, string)

Parâmetros

Devoluções

editProcess(UpdateProcessModel, string)

Parâmetros

Devoluções

getAllWorkItemTypeFields(string, string)

Parâmetros

Devoluções

getBehaviorForWorkItemType(string, string, string)

Parâmetros

Devoluções

getBehaviorsForWorkItemType(string, string)

Parâmetros

Devoluções

getFormLayout(string, string)

Parâmetros