WorkItemTrackingProcessDefinitionsRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
add |
Adiciona um comportamento ao tipo de item de trabalho do processo. |
add |
Cria um controle em um grupo |
add |
Adiciona um campo ao tipo de item de trabalho no processo. |
add |
Adiciona um grupo ao formulário de item de trabalho |
add |
Adiciona uma página ao formulário de item de trabalho |
create |
Cria um único comportamento no processo especificado. |
create |
Cria um único campo no processo. |
create |
Cria uma lista de seleção. |
create |
Cria uma definição de estado no tipo de item de trabalho do processo. |
create |
Cria um tipo de item de trabalho no processo. |
delete |
Remove um comportamento no processo. |
delete |
Remove uma lista de seleção. |
delete |
Remove uma definição de estado no tipo de item de trabalho do processo. |
delete |
Remove um tipo de item de trabalho no processo. |
edit |
Atualizações um controle no formulário do item de trabalho |
edit |
Atualizações um grupo no formulário de item de trabalho |
edit |
Atualizações uma página no formulário do item de trabalho |
get |
Retorna um único comportamento no processo. |
get |
Retorna um comportamento para o tipo de item de trabalho do processo. |
get |
Retorna uma lista de todos os comportamentos no processo. |
get |
Retorna uma lista de todos os comportamentos para o tipo de item de trabalho do processo. |
get |
Obtém o layout do formulário |
get |
Retorna uma lista de seleção. |
get |
Retorna metadados da lista de seleção. |
get |
Retorna uma definição de estado no tipo de item de trabalho do processo. |
get |
Retorna uma lista de todas as definições de estado no tipo de item de trabalho do processo. |
get |
Retorna um tipo de item de trabalho do processo. |
get |
Retorna um único campo no tipo de item de trabalho do processo. |
get |
Retorna uma lista de todos os campos no tipo de item de trabalho do processo. |
get |
Retorna uma lista de todos os tipos de item de trabalho no processo. |
hide |
Oculta uma definição de estado no tipo de item de trabalho do processo. |
remove |
Remove um comportamento para o tipo de item de trabalho do processo. |
remove |
Remove um controle do formulário de item de trabalho |
remove |
Remove um campo no tipo de item de trabalho do processo. |
remove |
Remove um grupo do formulário de item de trabalho |
remove |
Remove uma página do formulário de item de trabalho |
replace |
Substitui um comportamento no processo. |
set |
Move um controle para um novo grupo |
set |
Move um grupo para uma página e uma seção diferentes |
set |
Move um grupo para uma seção diferente |
update |
Atualizações tipo de item de trabalho padrão para o comportamento do processo. |
update |
Atualizações um determinado campo no processo. |
update |
Atualizações uma lista. |
update |
Atualizações uma determinada definição de estado no tipo de item de trabalho do processo. |
update |
Atualizações um tipo de item de trabalho do processo. |
update |
Atualizações um único campo no escopo do processo fornecido e do tipo de item de trabalho. |
new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)
Parâmetros
- options
- IVssRestClientOptions
static RESOURCE_AREA_ID: string
Valor da propriedade
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>
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>
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>
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>
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>
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>
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>
Cria uma lista de seleção.
function createList(picklist: PickListModel): Promise<PickListModel>
Parâmetros
- picklist
- PickListModel
Retornos
Promise<PickListModel>
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>
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>
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>
Remove uma lista de seleção.
function deleteList(listId: string): Promise<void>
Parâmetros
- listId
-
string
A ID da lista
Retornos
Promise<void>
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>
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>
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>
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>
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>
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>
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>
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[]>
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[]>
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>
Retorna uma lista de seleção.
function getList(listId: string): Promise<PickListModel>
Parâmetros
- listId
-
string
A ID da lista
Retornos
Promise<PickListModel>
Retorna metadados da lista de seleção.
function getListsMetadata(): Promise<PickListMetadataModel[]>
Retornos
Promise<PickListMetadataModel[]>
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>
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[]>
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>
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>
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[]>
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[]>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>