WorkItemTrackingProcessDefinitionsRestClient class

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

Extends

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 controlo num 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 opções.

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 opções.

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 controlo 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 de item de trabalho

getBehavior(string, string)

Devolve um único comportamento no processo.

getBehaviorForWorkItemType(string, string, string)

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

getBehaviors(string)

Devolve uma lista de todos os comportamentos no 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.

getListsMetadata()

Devolve metadados da lista de opções.

getStateDefinition(string, string, string)

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

getStateDefinitions(string, string)

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

getWorkItemType(string, string, GetWorkItemTypeExpand)

Devolve um tipo de item de trabalho do processo.

getWorkItemTypeField(string, string, string)

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

getWorkItemTypeFields(string, string)

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

getWorkItemTypes(string, GetWorkItemTypeExpand)

Devolve uma lista de todos os tipos de itens 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 controlo 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 controlo para um novo grupo

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

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

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

Move um grupo para uma secção diferente

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Atualizações tipo de item de trabalho predefinido 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 âmbito do tipo de item de trabalho e processo especificado.

Detalhes do Construtor

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Parâmetros

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

processId

string

O ID do processo

witRefNameForBehaviors

string

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

Devoluções

addControlToGroup(Control, string, string, string)

Cria um controlo num grupo

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

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

processId

string

O ID do processo

witRefNameForFields

string

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

Devoluções

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>

createBehavior(BehaviorCreateModel, string)

Cria um único comportamento no processo especificado.

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

Parâmetros

processId

string

O ID do processo

Devoluções

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

O ID do processo

Devoluções

Promise<FieldModel>

createList(PickListModel)

Cria uma lista de opções.

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

Parâmetros

picklist
PickListModel

Devoluções

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

processId

string

O ID do processo

witRefName

string

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

Devoluções

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

O ID do processo

Devoluções

deleteBehavior(string, string)

Remove um comportamento no processo.

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

Parâmetros

processId

string

O ID do processo

behaviorId

string

O ID do comportamento

Devoluções

Promise<void>

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>

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>

deleteWorkItemType(string, string)

Remove um tipo de item de trabalho no processo.

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

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

Atualizações um controlo 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 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>

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

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>

editPage(Page, string, string)

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

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

getBehavior(string, string)

Devolve um único comportamento no processo.

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

Parâmetros

processId

string

O ID do processo

behaviorId

string

O ID do comportamento

Devoluções

Promise<BehaviorModel>

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

getBehaviors(string)

Devolve uma lista de todos os comportamentos no processo.

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

Parâmetros

processId

string

O ID do processo

Devoluções

Promise<BehaviorModel[]>

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

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

Parâmetros

listId

string

O ID da lista

Devoluções

Promise<PickListModel>

getListsMetadata()

Devolve metadados da lista de opções.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Devoluções

getStateDefinition(string, string, string)

Devolve 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

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

getStateDefinitions(string, string)

Devolve 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

O ID do processo

witRefName

string

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

Devoluções

getWorkItemType(string, string, GetWorkItemTypeExpand)

Devolve um tipo de item de trabalho do processo.

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

Parâmetros

processId

string

O ID do processo

witRefName

string

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

Devoluções

getWorkItemTypeField(string, string, string)

Devolve 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

O ID do processo

witRefNameForFields

string

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

fieldRefName

string

O nome de referência do campo

Devoluções

getWorkItemTypeFields(string, string)

Devolve 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

O ID do processo

witRefNameForFields

string

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

Devoluções

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

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

Parâmetros

processId

string

O ID do processo

Devoluções

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

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

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

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

O ID do processo

witRefNameForFields

string

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

fieldRefName

string

O nome de referência do campo

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>

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

O ID do processo

behaviorId

string

O ID do comportamento

Devoluções

Promise<BehaviorModel>

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

Move um controlo 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 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 grupo do qual remover o controlo

Devoluções

Promise<Control>

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

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

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

removeFromPageId

string

ID da página para remover o grupo de

removeFromSectionId

string

ID da secção para remover o grupo de

Devoluções

Promise<Group>

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

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

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 para remover o grupo de

Devoluções

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, 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

updateField(FieldUpdate, string)

Atualizações um determinado campo no processo.

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

Parâmetros

field
FieldUpdate
processId

string

O ID do processo

Devoluções

Promise<FieldModel>

updateList(PickListModel, string)

Atualizações uma lista.

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

Parâmetros

picklist
PickListModel
listId

string

O ID da lista

Devoluções

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

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

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

O ID do processo

witRefName

string

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

Devoluções

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Atualizações um único campo no âmbito do tipo de item de trabalho e processo especificado.

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

Parâmetros

field
WorkItemTypeFieldModel2

O modelo com o qual pretende atualizar o campo

processId

string

O ID do processo

witRefNameForFields

string

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

Devoluções