WorkItemTrackingProcessRestClient class

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parâmetros

static RESOURCE_AREA_ID: string

Valor de Propriedade

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

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

Parâmetros

Devoluções

Adiciona um campo a um tipo de item de trabalho.

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

Parâmetros

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Cria um controlo num grupo.

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

Parâmetros

Devoluções

Cria uma lista de opções.

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

Parâmetros

Devoluções

Cria um processo.

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

Parâmetros

Devoluções

Cria um único comportamento no processo especificado.

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

Parâmetros

Devoluções

Cria um tipo de item de trabalho no processo.

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

Parâmetros

Devoluções

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

Devoluções

Remove uma lista de opções.

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

Parâmetros

Devoluções

Remove um comportamento no processo.

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

Parâmetros

Devoluções

Remove um processo de um ID específico.

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

Parâmetros

Devoluções

Remove um tipo de item de trabalho no processo.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

Devoluções

Editar um processo de um ID específico.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

Obtém o esquema de formulário.

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

Parâmetros

Devoluções

Devolve uma lista de opções.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Devolve metadados da lista de opções.

function getListsMetadata(): Promise<PickListMetadata[]>

Devoluções

Devolve um comportamento do processo.

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

Parâmetros

Devoluções

Devolve uma lista de todos os comportamentos no processo.

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

Parâmetros

Devoluções

Obtenha um único processo de um ID especificado.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

Devolve um campo num tipo de item de trabalho.

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

Parâmetros

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

Atualizações uma lista.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Substitui um comportamento no processo.

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções