WorkItemTrackingProcessDefinitionsRestClient class

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

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Adiciona um comportamento ao tipo de item de trabalho do processo.
addControlToGroup(Control, string, string, string)	Cria um controle em um grupo
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Adiciona um campo ao tipo de item de trabalho no processo.
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
createBehavior(BehaviorCreateModel, string)	Cria um único comportamento no processo especificado.
createField(FieldModel, string)	Cria um único campo no processo.
createList(PickListModel)	Cria uma lista de seleção.
createStateDefinition(WorkItemStateInputModel, string, string)	Cria uma definição de estado no tipo de item de trabalho do processo.
createWorkItemType(WorkItemTypeModel, string)	Cria um tipo de item de trabalho no processo.
deleteBehavior(string, string)	Remove um comportamento no processo.
deleteList(string)	Remove uma lista de seleção.
deleteStateDefinition(string, string, string)	Remove uma definição de estado no tipo de item de trabalho do processo.
deleteWorkItemType(string, string)	Remove um tipo de item de trabalho no processo.
editControl(Control, string, string, string, string)	Atualizações um controle no formulário do item de trabalho
editGroup(Group, string, string, string, string, string)	Atualizações um grupo no formulário de item de trabalho
editPage(Page, string, string)	Atualizações uma página no formulário do item de trabalho
getBehavior(string, string)	Retorna um único comportamento no processo.
getBehaviorForWorkItemType(string, string, string)	Retorna um comportamento para o tipo de item de trabalho do processo.
getBehaviors(string)	Retorna uma lista de todos os comportamentos no 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.
getListsMetadata()	Retorna metadados da lista de seleção.
getStateDefinition(string, string, string)	Retorna uma definição de estado no tipo de item de trabalho do processo.
getStateDefinitions(string, string)	Retorna uma lista de todas as definições de estado no tipo de item de trabalho do processo.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Retorna um tipo de item de trabalho do processo.
getWorkItemTypeField(string, string, string)	Retorna um único campo no tipo de item de trabalho do processo.
getWorkItemTypeFields(string, string)	Retorna uma lista de todos os campos no tipo de item de trabalho do processo.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Retorna uma lista de todos os tipos de item de trabalho no processo.
hideStateDefinition(HideStateModel, string, string, string)	Oculta uma definição de estado no tipo de item de trabalho do processo.
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 de item de trabalho
removeFieldFromWorkItemType(string, string, string)	Remove um campo no tipo de item de trabalho do processo.
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
replaceBehavior(BehaviorReplaceModel, string, string)	Substitui um comportamento no processo.
setControlInGroup(Control, string, string, string, string, string)	Move um controle para um novo grupo
setGroupInPage(Group, string, string, string, string, string, string, string)	Move um grupo para uma página e uma seção diferentes
setGroupInSection(Group, string, string, string, string, string, string)	Move um grupo para uma seção diferente
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Atualizações tipo de item de trabalho padrão para o comportamento do processo.
updateField(FieldUpdate, string)	Atualizações um determinado campo no processo.
updateList(PickListModel, string)	Atualizações uma lista.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Atualizações uma determinada definição de estado no tipo de item de trabalho do processo.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Atualizações um tipo de item de trabalho do processo.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Atualizações um único campo no escopo do processo fornecido e do tipo de item de trabalho.

Detalhes do construtor

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

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

addControlToGroup(Control, string, string, string)

Cria um controle em um grupo

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

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Adiciona um campo ao tipo de item de trabalho no processo.

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

Parâmetros

field

WorkItemTypeFieldModel2

processId

string

A ID do processo

witRefNameForFields

string

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

Retornos

Promise<WorkItemTypeFieldModel2>

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

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>

createBehavior(BehaviorCreateModel, string)

Cria um único comportamento no processo especificado.

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

Parâmetros

behavior

BehaviorCreateModel

processId

string

A ID do processo

Retornos

Promise<BehaviorModel>

createField(FieldModel, string)

Cria um único campo no processo.

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

Parâmetros

field

FieldModel

processId

string

A ID do processo

Retornos

Promise<FieldModel>

createList(PickListModel)

Cria uma lista de seleção.

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

Parâmetros

picklist

PickListModel

Retornos

Promise<PickListModel>

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>

createWorkItemType(WorkItemTypeModel, string)

Cria um tipo de item de trabalho no processo.

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

Parâmetros

workItemType

WorkItemTypeModel

processId

string

A ID do processo

Retornos

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Remove um comportamento no processo.

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

Parâmetros

processId

string

A ID do processo

behaviorId

string

A ID do comportamento

Retornos

Promise<void>

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>

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>

deleteWorkItemType(string, string)

Remove um tipo de item de trabalho no processo.

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

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

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

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

A ID do controle

Retornos

Promise<Control>

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

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

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

editPage(Page, string, string)

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

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

getBehavior(string, string)

Retorna um único comportamento no processo.

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

Parâmetros

processId

string

A ID do processo

behaviorId

string

A ID do comportamento

Retornos

Promise<BehaviorModel>

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>

getBehaviors(string)

Retorna uma lista de todos os comportamentos no processo.

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

Parâmetros

processId

string

A ID do processo

Retornos

Promise<BehaviorModel[]>

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<PickListModel>

Parâmetros

listId

string

A ID da lista

Retornos

Promise<PickListModel>

getListsMetadata()

Retorna metadados da lista de seleção.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Retornos

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

Retorna uma definição de estado no 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 no 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[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Retorna um tipo de item de trabalho do processo.

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

Parâmetros

processId

string

A ID do processo

witRefName

string

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

expand

GetWorkItemTypeExpand

Retornos

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Retorna um único campo no tipo de item de trabalho do processo.

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

Parâmetros

processId

string

A ID do processo

witRefNameForFields

string

Nome de referência de tipo de item de trabalho para campos

fieldRefName

string

O nome de referência do campo

Retornos

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

Retorna uma lista de todos os campos no tipo de item de trabalho do processo.

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

Parâmetros

processId

string

A ID do processo

witRefNameForFields

string

Nome de referência de tipo de item de trabalho para campos

Retornos

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

Retorna uma lista de todos os tipos de item de trabalho no processo.

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

Parâmetros

processId

string

A ID do processo

expand

GetWorkItemTypeExpand

Retornos

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

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

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>

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 de 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>

removeFieldFromWorkItemType(string, string, string)

Remove um campo no tipo de item de trabalho do processo.

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

Parâmetros

processId

string

A ID do processo

witRefNameForFields

string

Nome de referência de tipo de item de trabalho para campos

fieldRefName

string

O nome de referência do campo

Retornos

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

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>

replaceBehavior(BehaviorReplaceModel, string, string)

Substitui um comportamento no processo.

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

Parâmetros

behaviorData

BehaviorReplaceModel

processId

string

A ID do processo

behaviorId

string

A ID do comportamento

Retornos

Promise<BehaviorModel>

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

Move um controle para um novo grupo

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

A ID do controle

removeFromGroupId

string

O grupo do qual remover o controle

Retornos

Promise<Control>

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

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

function setGroupInPage(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 em que o grupo está

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>

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

Move um grupo para uma seção diferente

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

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Atualizações tipo de item de trabalho padrão para o comportamento 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>

updateField(FieldUpdate, string)

Atualizações um determinado campo no processo.

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

Parâmetros

field

FieldUpdate

processId

string

A ID do processo

Retornos

Promise<FieldModel>

updateList(PickListModel, string)

Atualizações uma lista.

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

Parâmetros

picklist

PickListModel

listId

string

A ID da lista

Retornos

Promise<PickListModel>

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>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

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

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

Parâmetros

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

A ID do processo

witRefName

string

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

Retornos

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Atualizações um único campo no escopo do processo fornecido e do tipo de item de trabalho.

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

Parâmetros

field

WorkItemTypeFieldModel2

O modelo com o qual atualizar o campo

processId

string

A ID do processo

witRefNameForFields

string

Nome de referência de tipo de item de trabalho para campos

Retornos

Promise<WorkItemTypeFieldModel2>