WorkItemTrackingProcessRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para 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 do 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 controle em um grupo.
createList(PickList)	Cria uma lista de seleção.
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 seleção.
deleteProcessBehavior(string, string)	Remove um comportamento no processo.
deleteProcessById(string)	Remove um processo de uma ID específica.
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)	Exclui uma modificação de controle do sistema no formulário do item de trabalho.
editProcess(UpdateProcessModel, string)	Edite um processo de uma ID específica.
getAllWorkItemTypeFields(string, string)	Retorna uma lista de todos os campos em um tipo de item de trabalho.
getBehaviorForWorkItemType(string, string, string)	Retorna um comportamento para o tipo de item de trabalho do processo.
getBehaviorsForWorkItemType(string, string)	Retorna uma lista de todos os comportamentos para o tipo de item de trabalho do processo.
getFormLayout(string, string)	Obtém o layout do formulário.
getList(string)	Retorna uma lista de seleção.
getListOfProcesses(GetProcessExpandLevel)	Obtenha a lista de todos os processos, incluindo sistema e herdados.
getListsMetadata()	Retorna metadados da lista de seleção.
getProcessBehavior(string, string, GetBehaviorsExpand)	Retorna um comportamento do processo.
getProcessBehaviors(string, GetBehaviorsExpand)	Retorna uma lista de todos os comportamentos no processo.
getProcessByItsId(string, GetProcessExpandLevel)	Obtenha um único processo de uma ID especificada.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Retorna um único tipo de item de trabalho em um processo.
getProcessWorkItemTypeRule(string, string, string)	Retorna uma única regra no tipo de item de trabalho do processo.
getProcessWorkItemTypeRules(string, string)	Retorna uma lista de todas as regras no tipo de item de trabalho do processo.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Retorna uma lista de todos os tipos de item de trabalho em um processo.
getStateDefinition(string, string, string)	Retorna uma única definição de estado em um tipo de item de trabalho do processo.
getStateDefinitions(string, string)	Retorna uma lista de todas as definições de estado em um tipo de item de trabalho do processo.
getSystemControls(string, string)	Obtém controles de sistema editados para um tipo de item de trabalho em um processo. Para obter todos os controles do sistema (base + editado) use as API(s) de layout
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Retorna um campo em um tipo de item de trabalho.
hideStateDefinition(HideStateModel, string, string, string)	Oculta uma definição de estado no tipo de item de trabalho do processo. Somente estados com customizationType:System podem ser ocultos.
moveControlToGroup(Control, string, string, string, string, string)	Move um controle para um grupo especificado.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Move um grupo para uma página e uma seção diferentes.
moveGroupToSection(Group, string, string, string, string, string, string)	Move um grupo para uma seçã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 controle do formulário do item de trabalho.
removeGroup(string, string, string, string, string)	Remove um grupo do formulário do 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 exclui 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 controle 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 do 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 controle do sistema no formulário do item de trabalho.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Atualizações um campo em um tipo de item de trabalho.

Detalhes do construtor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do 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

A ID do processo

witRefNameForBehaviors: string

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

Retornos

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

A ID do processo.

witRefName: string

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

Retornos

Promise<ProcessWorkItemTypeField>

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

Adiciona um grupo ao formulário do 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

A ID do processo.

witRefName: string

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

pageId: string

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

sectionId: string

A ID da seção à qual adicionar o grupo.

Retornos

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

A ID do processo.

witRefName: string

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

Retornos

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

A ID do processo

witRefName: string

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

Retornos

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Cria um controle em um grupo.

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

Parâmetros

control: Control

O controle .

processId: string

A ID do processo.

witRefName: string

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

groupId: string

A ID do grupo ao qual adicionar o controle.

Retornos

Promise<Control>

createList(PickList)

Cria uma lista de seleção.

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

Parâmetros

picklist: PickList

Lista de seleção

Retornos

Promise<PickList>

createNewProcess(CreateProcessModel)

Cria um processo.

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

Parâmetros

createRequest: CreateProcessModel

CreateProcessModel.

Retornos

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

A ID do processo

Retornos

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

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

Retornos

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

A ID do processo

witRefName: string

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

Retornos

Promise<WorkItemStateResultModel>

deleteList(string)

Remove uma lista de seleção.

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

Parâmetros

listId: string

A ID da lista

Retornos

Promise<void>

deleteProcessBehavior(string, string)

Remove um comportamento no processo.

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

Parâmetros

processId: string

A ID do processo

behaviorRefName: string

O nome de referência do comportamento

Retornos

Promise<void>

deleteProcessById(string)

Remove um processo de uma ID específica.

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

Parâmetros

processTypeId: string

Retornos

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

A ID do processo.

witRefName: string

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

Retornos

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

A ID do processo

witRefName: string

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

ruleId: string

A ID da regra

Retornos

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

Retornos

Promise<void>

deleteSystemControl(string, string, string)

Exclui uma modificação de controle do sistema no formulário do item de trabalho.

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

Parâmetros

processId: string

A ID do processo.

witRefName: string

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

controlId: string

O ID do controle.

Retornos

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Edite um processo de uma ID específica.

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

Parâmetros

updateRequest: UpdateProcessModel

processTypeId: string

Retornos

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Retorna uma lista de todos os campos em um tipo de item de trabalho.

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

Parâmetros

processId: string

A ID do processo.

witRefName: string

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

Retornos

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Retorna 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

A 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

Retornos

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Retorna uma lista de todos os comportamentos para o tipo de item de trabalho do processo.

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

Parâmetros

processId: string

A ID do processo

witRefNameForBehaviors: string

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

Retornos

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Obtém o layout do formulário.

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

Parâmetros

processId: string

A ID do processo.

witRefName: string

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

Retornos

Promise<FormLayout>

getList(string)

Retorna uma lista de seleção.

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

Parâmetros

listId: string

A ID da lista

Retornos

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Obtenha a lista de todos os processos, incluindo sistema e herdados.

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

Parâmetros

expand: GetProcessExpandLevel

Retornos

Promise<ProcessInfo[]>

getListsMetadata()

Retorna metadados da lista de seleção.

function getListsMetadata(): Promise<PickListMetadata[]>

Retornos

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Retorna um comportamento do processo.

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

Parâmetros

processId: string

A ID do processo

behaviorRefName: string

O nome de referência do comportamento

expand: GetBehaviorsExpand

Retornos

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Retorna uma lista de todos os comportamentos no processo.

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

Parâmetros

processId: string

A ID do processo

expand: GetBehaviorsExpand

Retornos

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Obtenha um único processo de uma ID especificada.

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

Parâmetros

processTypeId: string

expand: GetProcessExpandLevel

Retornos

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Retorna um único tipo de item de trabalho em um processo.

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

Parâmetros

processId: string

A ID do processo

witRefName: string

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

expand: GetWorkItemTypeExpand

Sinalizador para determinar quais propriedades do tipo de item de trabalho devem ser retornadas

Retornos

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Retorna 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

A ID do processo

witRefName: string

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

ruleId: string

A ID da regra

Retornos

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Retorna 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

A ID do processo

witRefName: string

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

Retornos

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Retorna uma lista de todos os tipos de item de trabalho em um processo.

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

Parâmetros

processId: string

A ID do processo

expand: GetWorkItemTypeExpand

Sinalizador para determinar quais propriedades do tipo de item de trabalho devem ser retornadas

Retornos

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Retorna uma única definição de estado em um tipo de item de trabalho do processo.

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

Parâmetros

processId: string

A ID do processo

witRefName: string

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

stateId: string

A ID do estado

Retornos

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Retorna uma lista de todas as definições de estado em um tipo de item de trabalho do processo.

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

Parâmetros

processId: string

A ID do processo

witRefName: string

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

Retornos

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Obtém controles de sistema editados para um tipo de item de trabalho em um processo. Para obter todos os controles do sistema (base + editado) use as API(s) de layout

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

Parâmetros

processId: string

A ID do processo.

witRefName: string

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

Retornos

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Retorna um campo em um tipo de item de trabalho.

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

Parâmetros

processId: string

A 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

Retornos

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

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

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

Parâmetros

hideStateModel: HideStateModel

processId: string

A ID do processo

witRefName: string

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

stateId: string

A ID do estado

Retornos

Promise<WorkItemStateResultModel>

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

Move um controle 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 controle .

processId: string

A ID do processo.

witRefName: string

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

groupId: string

A ID do grupo para o qual mover o controle.

controlId: string

O ID do controle.

removeFromGroupId: string

A ID do grupo da qual remover o controle.

Retornos

Promise<Control>

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

Move um grupo para uma página e uma seçã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

A ID do processo.

witRefName: string

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

pageId: string

A ID da página em que o grupo está.

sectionId: string

A ID da seção do grupo é i.n

groupId: string

A ID do grupo.

removeFromPageId: string

ID da página da qual remover o grupo.

removeFromSectionId: string

ID da seção da qual remover o grupo.

Retornos

Promise<Group>

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

Move um grupo para uma seçã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

A ID do processo.

witRefName: string

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

pageId: string

A ID da página em que o grupo está.

sectionId: string

A ID da seção em que o grupo está.

groupId: string

A ID do grupo.

removeFromSectionId: string

ID da seção da qual remover o grupo.

Retornos

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

A 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

Retornos

Promise<void>

removeControlFromGroup(string, string, string, string)

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

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

Parâmetros

processId: string

A ID do processo.

witRefName: string

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

groupId: string

A ID do grupo.

controlId: string

A ID do controle a ser removido.

Retornos

Promise<void>

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

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

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

Parâmetros

processId: string

A ID do processo

witRefName: string

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

pageId: string

A ID da página em que o grupo está

sectionId: string

A ID da seção para o grupo está em

groupId: string

A ID do grupo

Retornos

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

A ID do processo

witRefName: string

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

pageId: string

A ID da página

Retornos

Promise<void>

removeWorkItemTypeField(string, string, string)

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

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

Parâmetros

processId: string

A 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.

Retornos

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

A ID do processo

witRefNameForBehaviors: string

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

Retornos

Promise<WorkItemTypeBehavior>

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

Atualizações um controle 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 controle atualizado.

processId: string

A ID do processo.

witRefName: string

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

groupId: string

A ID do grupo.

controlId: string

O ID do controle.

Retornos

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

A ID do processo.

witRefName: string

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

pageId: string

A ID da página em que o grupo está.

sectionId: string

A ID da seção em que o grupo está.

groupId: string

A ID do grupo.

Retornos

Promise<Group>

updateList(PickList, string)

Atualizações uma lista.

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

Parâmetros

picklist: PickList

listId: string

A ID da lista

Retornos

Promise<PickList>

updatePage(Page, string, string)

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

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

Parâmetros

page: Page

A página

processId: string

A ID do processo

witRefName: string

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

Retornos

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

A ID do processo

behaviorRefName: string

O nome de referência do comportamento

Retornos

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

A ID do processo

witRefName: string

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

Retornos

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

A ID do processo

witRefName: string

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

ruleId: string

A ID da regra

Retornos

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

Retornos

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

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

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

Parâmetros

control: Control

processId: string

A ID do processo.

witRefName: string

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

controlId: string

O ID do controle.

Retornos

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

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

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

Parâmetros

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

A 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.

Retornos

Promise<ProcessWorkItemTypeField>

Compartilhar via

WorkItemTrackingProcessRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Parâmetros

Retornos

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Parâmetros

Retornos

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

Parâmetros

Retornos

addPage(Page, string, string)

Parâmetros

Retornos

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Parâmetros

Retornos

createControlInGroup(Control, string, string, string)

Parâmetros

Retornos

createList(PickList)

Parâmetros

Retornos

createNewProcess(CreateProcessModel)

Parâmetros

Retornos

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Parâmetros

Retornos

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Parâmetros

Retornos

createStateDefinition(WorkItemStateInputModel, string, string)

Parâmetros

Retornos

deleteList(string)

Parâmetros

Retornos

deleteProcessBehavior(string, string)

Parâmetros

Retornos

deleteProcessById(string)

Parâmetros

Retornos

deleteProcessWorkItemType(string, string)

Parâmetros

Retornos

deleteProcessWorkItemTypeRule(string, string, string)

Parâmetros

Retornos

deleteStateDefinition(string, string, string)

Parâmetros

Retornos

deleteSystemControl(string, string, string)

Parâmetros

Retornos

editProcess(UpdateProcessModel, string)

Parâmetros

Retornos

getAllWorkItemTypeFields(string, string)

Parâmetros

Retornos

getBehaviorForWorkItemType(string, string, string)

Parâmetros

Retornos

getBehaviorsForWorkItemType(string, string)

Parâmetros

Retornos

getFormLayout(string, string)

Parâmetros