WorkItemTrackingRestClient class

Referência

Pacote:: azure-devops-extension-api

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

Extends: RestClientBase

Construtores

WorkItemTrackingRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createAttachment(any, string, string, string, string)	Carrega um anexo.
createField(WorkItemField, string)	Crie um novo campo.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Crie um novo ou atualize um nó de classificação existente.
createQuery(QueryHierarchyItem, string, string, boolean)	Cria uma consulta ou move uma consulta.
createTemplate(WorkItemTemplate, string, string)	Cria um modelo
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Cria um único item de trabalho.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Eliminar um nó de classificação existente.
deleteField(string, string)	Elimina o campo. Para anular a eliminação de um ficheiro, consulte a API "Atualizar Campo".
deleteQuery(string, string)	Eliminar uma consulta ou uma pasta. Isto elimina qualquer alteração de permissão na consulta ou pasta eliminada e em qualquer um dos seus descendentes se for uma pasta. É importante ter em atenção que as alterações de permissão eliminadas não podem ser recuperadas ao anular a eliminação da consulta ou da pasta.
deleteTemplate(string, string, string)	Elimina o modelo com o ID especificado
deleteWorkItem(number, string, boolean)	Elimina o item de trabalho especificado e envia-o para a Reciclagem, para que possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro de destruição tiver sido definido como verdadeiro, destruirá permanentemente o item de trabalho. AVISO: se o parâmetro de destruição estiver definido como verdadeiro, os itens de trabalho eliminados por este comando NÃO irão para a reciclagem e não haverá forma de restaurá-los/recuperá-los após a eliminação. Recomenda-se NÃO utilizar este parâmetro. Se o fizer, utilize este parâmetro com extrema atenção.
destroyWorkItem(number, string)	Destrói permanentemente o item de trabalho especificado da Reciclagem. Esta ação não pode ser anulada.
exportWorkItemTypeDefinition(string, string, boolean)	Exportar tipo de item de trabalho
getAccountMyWorkData(QueryOption)	APENAS INTERNO: UTILIZADO POR CONTA A MINHA PÁGINA DE TRABALHO. Isto devolve os detalhes dos itens de trabalho a fazer, concluídos, seguidos e de atividade.
getAttachmentContent(string, string, string, boolean)	Transfere um anexo.
getAttachmentZip(string, string, string, boolean)	Transfere um anexo.
getClassificationNode(string, TreeStructureGroup, string, number)	Obtém o nó de classificação para um determinado caminho de nó.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Obtém nós de classificação de raiz ou lista de nós de classificação para uma determinada lista de ids de nós, para um determinado projeto. Caso seja fornecido o parâmetro IDS, obterá uma lista de nós de classificação para esses IDs. Caso contrário, obterá nós de classificação de raiz para este projeto.
getComment(number, number, string)	Obtém um comentário para um item de trabalho na revisão especificada.
getComments(number, string, number, number, CommentSortOrder)	Obtém o número especificado de comentários para um item de trabalho a partir da revisão especificada.
getDeletedWorkItem(number, string)	Obtém um item de trabalho eliminado da Reciclagem.
getDeletedWorkItems(number[], string)	Obtém os itens de trabalho da reciclagem, cujos IDs foram especificados nos parâmetros
getDeletedWorkItemShallowReferences(string)	Obtém uma lista dos IDs e dos URLs dos itens de trabalho eliminados na Reciclagem.
getField(string, string)	Obtém informações num campo específico.
getFields(string, GetFieldsExpand)	Devolve informações para todos os campos. O parâmetro ID/nome do projeto é opcional.
getQueries(string, QueryExpand, number, boolean)	Obtém as consultas raiz e os seus filhos
getQueriesBatch(QueryBatchGetRequest, string)	Obtém uma lista de consultas por IDs (Máximo de 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Obtém uma consulta individual e os respetivos subordinados
getQueryResultCount(string, string, string, boolean, number)	Obtém os resultados da consulta com o ID da consulta.
getRecentActivityData()	Obtém atividades de itens de trabalho recentes
getRecentMentions()	APENAS INTERNO: UTILIZADO POR CONTA A MINHA PÁGINA DE TRABALHO.
getRelationType(string)	Obtém a definição do tipo de relação do item de trabalho.
getRelationTypes()	Obtém os tipos de relação do item de trabalho.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Obter um lote de ligações de itens de trabalho
getRevision(number, number, string, WorkItemExpand)	Devolve um item de trabalho totalmente hidratado para a revisão pedida
getRevisions(number, string, number, number, WorkItemExpand)	Devolve a lista de revisões de itens de trabalho totalmente hidratados, paginadas.
getRootNodes(string, number)	Obtém nós de classificação de raiz no projeto.
getTemplate(string, string, string)	Obtém o modelo com o ID especificado
getTemplates(string, string, string)	Obtém o modelo
getUpdate(number, number, string)	Devolve uma única atualização para um item de trabalho
getUpdates(number, string, number, number)	Devolve os deltas entre revisões de itens de trabalho
getWorkArtifactLinkTypes()	Obtenha a lista de itens de trabalho que monitorizam os tipos de ligação de artefactos de saída.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Devolve um único item de trabalho.
getWorkItemIconJson(string, string, number)	Obtenha um ícone de item de trabalho com o nome amigável e a cor do ícone.
getWorkItemIcons()	Obtenha uma lista de todos os ícones de itens de trabalho.
getWorkItemIconSvg(string, string, number)	Obtenha um ícone de item de trabalho com o nome amigável e a cor do ícone.
getWorkItemIconXaml(string, string, number)	Obtenha um ícone de item de trabalho com o nome amigável e a cor do ícone.
getWorkItemNextStatesOnCheckinAction(number[], string)	Devolve o estado seguinte nos IDs de item de trabalho especificados.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Devolve uma lista de itens de trabalho (Máximo de 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Obtém itens de trabalho para uma lista de IDs de itens de trabalho (Máximo de 200)
getWorkItemStateColors(string[])	APENAS INTERNO: será utilizado para a experiência profissional A minha conta. Obter a cor de estado do tipo de item de trabalho para vários projetos
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Devolve um único item de trabalho de um modelo.
getWorkItemType(string, string)	Devolve uma definição de tipo de item de trabalho.
getWorkItemTypeCategories(string)	Obtenha todas as categorias de tipo de item de trabalho.
getWorkItemTypeCategory(string, string)	Obtenha categoria de tipo de item de trabalho específica por nome.
getWorkItemTypeColorAndIcons(string[])	APENAS INTERNO: é utilizado para fornecedores de cores e ícones. Obter a cor do tipo de sagacidade para vários projetos
getWorkItemTypeColors(string[])	APENAS INTERNO: será utilizado para a experiência profissional A minha conta. Obter a cor do tipo de sagacidade para vários projetos
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Obtenha uma lista de campos para um tipo de item de trabalho com referências detalhadas.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Obtenha um campo para um tipo de item de trabalho com referências detalhadas.
getWorkItemTypes(string)	Devolve a lista de tipos de itens de trabalho
getWorkItemTypeStates(string, string)	Devolve os nomes de estado e as cores de um tipo de item de trabalho.
queryById(string, string, string, boolean, number)	Obtém os resultados da consulta com o ID da consulta.
queryByWiql(Wiql, string, string, boolean, number)	Obtém os resultados da consulta, dado o WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	As consultas funcionam com itens ligados a uma determinada lista de URI de artefactos.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Obter um lote de revisões de itens de trabalho com a opção de incluir itens eliminados
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Obter um lote de revisões de itens de trabalho. Este pedido poderá ser utilizado se a sua lista de campos for suficientemente grande para que possa executar o URL acima do limite de comprimento.
replaceTemplate(WorkItemTemplate, string, string, string)	Substituir conteúdo do modelo
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Restaura o item de trabalho eliminado da Reciclagem.
searchQueries(string, string, number, QueryExpand, boolean)	Procura todas as consultas às quais o utilizador tem acesso no projeto atual
sendMail(SendMailBody, string)	Método RESTful para enviar correio para itens de trabalho selecionados/consultados.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Atualizar um nó de classificação existente.
updateField(UpdateWorkItemField, string, string)	Atualizar um campo.
updateQuery(QueryHierarchyItem, string, string, boolean)	Atualizar uma consulta ou uma pasta. Isto permite-lhe atualizar, mudar o nome e mover consultas e pastas.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Atualizações um único item de trabalho.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Adicionar/atualizar um tipo de item de trabalho

Detalhes do Construtor

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

createAttachment(any, string, string, string, string)

Carrega um anexo.

function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>

Parâmetros

content: any

Conteúdo a carregar

project: string

ID do Projeto ou nome do projeto

fileName: string

O nome do ficheiro

uploadType: string

Tipo de carregamento de anexos: Simples ou Segmentado

areaPath: string

Caminho da Área do projeto de destino

Devoluções

Promise<AttachmentReference>

createField(WorkItemField, string)

Crie um novo campo.

function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>

Parâmetros

workItemField: WorkItemField

Nova definição de campo

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Crie um novo ou atualize um nó de classificação existente.

function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Parâmetros

postedNode: WorkItemClassificationNode

Nó para criar ou atualizar.

project: string

ID do Projeto ou nome do projeto

structureGroup: TreeStructureGroup

Grupo estrutura do nó de classificação, área ou iteração.

path: string

Caminho do nó de classificação.

Devoluções

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Cria uma consulta ou move uma consulta.

function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>

Parâmetros

postedQuery: QueryHierarchyItem

A consulta a criar.

project: string

ID do Projeto ou nome do projeto

query: string

O ID principal ou o caminho no qual a consulta deve ser criada.

validateWiqlOnly: boolean

Se apenas quiser validar a consulta WIQL sem realmente criar uma, defina-a como verdadeira. A predefinição é falso.

Devoluções

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Cria um modelo

function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>

Parâmetros

template: WorkItemTemplate

Conteúdo do modelo

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

Devoluções

Promise<WorkItemTemplate>

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Cria um único item de trabalho.

function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Parâmetros

document: JsonPatchDocument

O documento de Patch JSON que representa o item de trabalho

project: string

ID do Projeto ou nome do projeto

type: string

O tipo de item de trabalho do item de trabalho a criar

validateOnly: boolean

Indicar se apenas pretende validar as alterações sem guardar o item de trabalho

bypassRules: boolean

Não impor as regras de tipo de item de trabalho nesta atualização

suppressNotifications: boolean

Não acione notificações para esta alteração

expand: WorkItemExpand

Os parâmetros de expansão para atributos de itens de trabalho. As opções possíveis são { Nenhum, Relações, Campos, Ligações, Tudo }.

Devoluções

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Eliminar um nó de classificação existente.

function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>

Parâmetros

project: string

ID do Projeto ou nome do projeto

structureGroup: TreeStructureGroup

Grupo estrutura do nó de classificação, área ou iteração.

path: string

Caminho do nó de classificação.

reclassifyId: number

ID do nó de classificação de destino para reclassificação.

Devoluções

Promise<void>

deleteField(string, string)

Elimina o campo. Para anular a eliminação de um ficheiro, consulte a API "Atualizar Campo".

function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>

Parâmetros

fieldNameOrRefName: string

Nome ou nome de referência simples do campo

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<void>

deleteQuery(string, string)

Eliminar uma consulta ou uma pasta. Isto elimina qualquer alteração de permissão na consulta ou pasta eliminada e em qualquer um dos seus descendentes se for uma pasta. É importante ter em atenção que as alterações de permissão eliminadas não podem ser recuperadas ao anular a eliminação da consulta ou da pasta.

function deleteQuery(project: string, query: string): Promise<void>

Parâmetros

project: string

ID do Projeto ou nome do projeto

query: string

ID ou caminho da consulta ou pasta a eliminar.

Devoluções

Promise<void>

deleteTemplate(string, string, string)

Elimina o modelo com o ID especificado

function deleteTemplate(project: string, team: string, templateId: string): Promise<void>

Parâmetros

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

templateId: string

ID do modelo

Devoluções

Promise<void>

deleteWorkItem(number, string, boolean)

Elimina o item de trabalho especificado e envia-o para a Reciclagem, para que possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro de destruição tiver sido definido como verdadeiro, destruirá permanentemente o item de trabalho. AVISO: se o parâmetro de destruição estiver definido como verdadeiro, os itens de trabalho eliminados por este comando NÃO irão para a reciclagem e não haverá forma de restaurá-los/recuperá-los após a eliminação. Recomenda-se NÃO utilizar este parâmetro. Se o fizer, utilize este parâmetro com extrema atenção.

function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>

Parâmetros

id: number

ID do item de trabalho a eliminar

project: string

ID do Projeto ou nome do projeto

destroy: boolean

Parâmetro opcional, se definido como verdadeiro, o item de trabalho é eliminado permanentemente. Tenha em atenção que a ação de destruição é PERMANENTE e não pode ser anulada.

Devoluções

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Destrói permanentemente o item de trabalho especificado da Reciclagem. Esta ação não pode ser anulada.

function destroyWorkItem(id: number, project?: string): Promise<void>

Parâmetros

id: number

ID do item de trabalho a ser destruído permanentemente

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Exportar tipo de item de trabalho

function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>

Parâmetros

project: string

ID do Projeto ou nome do projeto

type: string

exportGlobalLists: boolean

Devoluções

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

APENAS INTERNO: UTILIZADO POR CONTA A MINHA PÁGINA DE TRABALHO. Isto devolve os detalhes dos itens de trabalho a fazer, concluídos, seguidos e de atividade.

function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>

Parâmetros

queryOption: QueryOption

Devoluções

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Transfere um anexo.

function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Parâmetros

id: string

ID do Anexo

project: string

ID do Projeto ou nome do projeto

fileName: string

Nome do ficheiro

download: boolean

Se estiver definido como <c>true</c> , transfira sempre o anexo

Devoluções

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Transfere um anexo.

function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Parâmetros

id: string

ID do Anexo

project: string

ID do Projeto ou nome do projeto

fileName: string

Nome do ficheiro

download: boolean

Se estiver definido como <c>true</c> , transfira sempre o anexo

Devoluções

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Obtém o nó de classificação para um determinado caminho de nó.

function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>

Parâmetros

project: string

ID do Projeto ou nome do projeto

structureGroup: TreeStructureGroup

Grupo estrutura do nó de classificação, área ou iteração.

path: string

Caminho do nó de classificação.

depth: number

Profundidade das crianças a obter.

Devoluções

Promise<WorkItemClassificationNode>

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Obtém nós de classificação de raiz ou lista de nós de classificação para uma determinada lista de ids de nós, para um determinado projeto. Caso seja fornecido o parâmetro IDS, obterá uma lista de nós de classificação para esses IDs. Caso contrário, obterá nós de classificação de raiz para este projeto.

function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

ids: number[]

IDs de nós de classificação de números inteiros separados por vírgulas. Não é necessário, se quiser nós de raiz.

depth: number

Profundidade das crianças a obter.

errorPolicy: ClassificationNodesErrorPolicy

Sinalizar para processar erros na obtenção de alguns nós. As opções possíveis são Falhar e Omitir.

Devoluções

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Obtém um comentário para um item de trabalho na revisão especificada.

function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>

Parâmetros

id: number

ID do item de trabalho

revision: number

Revisão para a qual o comentário tem de ser obtido

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemComment>

getComments(number, string, number, number, CommentSortOrder)

Obtém o número especificado de comentários para um item de trabalho a partir da revisão especificada.

function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>

Parâmetros

id: number

ID do item de trabalho

project: string

ID do Projeto ou nome do projeto

fromRevision: number

Revisão a partir da qual os comentários devem ser obtidos (a predefinição é 1)

top: number

O número de comentários a devolver (a predefinição é 200)

order: CommentSortOrder

Ascendente ou descendente por ID de revisão (a predefinição é ascendente)

Devoluções

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Obtém um item de trabalho eliminado da Reciclagem.

function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>

Parâmetros

id: number

ID do item de trabalho a devolver

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Obtém os itens de trabalho da reciclagem, cujos IDs foram especificados nos parâmetros

function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>

Parâmetros

ids: number[]

Lista separada por vírgulas de IDs dos itens de trabalho eliminados a devolver

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Obtém uma lista dos IDs e dos URLs dos itens de trabalho eliminados na Reciclagem.

function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Obtém informações num campo específico.

function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Parâmetros

fieldNameOrRefName: string

Nome ou nome de referência simples do campo

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Devolve informações para todos os campos. O parâmetro ID/nome do projeto é opcional.

function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

expand: GetFieldsExpand

Utilize ExtensionFields para incluir campos de extensão, caso contrário, exclua-os. A menos que o sinalizador de funcionalidade para este parâmetro esteja ativado, os campos de extensão são sempre incluídos.

Devoluções

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Obtém as consultas raiz e os seus filhos

function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

expand: QueryExpand

Inclua a cadeia de consulta (wiql), cláusulas, colunas de resultados de consulta e opções de ordenação nos resultados.

depth: number

Na pasta de consultas, devolva consultas e pastas subordinadas a esta profundidade.

includeDeleted: boolean

Incluir consultas e pastas eliminadas

Devoluções

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Obtém uma lista de consultas por IDs (Máximo de 1000)

function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>

Parâmetros

queryGetRequest: QueryBatchGetRequest

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<QueryHierarchyItem[]>

getQuery(string, string, QueryExpand, number, boolean, boolean)

Obtém uma consulta individual e os respetivos subordinados

function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>

Parâmetros

project: string

ID do Projeto ou nome do projeto

query: string

ID ou caminho da consulta.

expand: QueryExpand

Inclua a cadeia de consulta (wiql), cláusulas, colunas de resultados de consulta e opções de ordenação nos resultados.

depth: number

Na pasta de consultas, devolva consultas e pastas subordinadas a esta profundidade.

includeDeleted: boolean

Incluir consultas e pastas eliminadas

useIsoDateFormat: boolean

As cláusulas de consulta DateTime serão formatadas com um formato compatível com ISO 8601

Devoluções

Promise<QueryHierarchyItem>

getQueryResultCount(string, string, string, boolean, number)

Obtém os resultados da consulta com o ID da consulta.

function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>

Parâmetros

id: string

O ID da consulta.

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

timePrecision: boolean

Quer utilize ou não a precisão de tempo.

top: number

O número máximo de resultados a devolver.

Devoluções

Promise<number>

getRecentActivityData()

Obtém atividades de itens de trabalho recentes

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Devoluções

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

APENAS INTERNO: UTILIZADO POR CONTA A MINHA PÁGINA DE TRABALHO.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Devoluções

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Obtém a definição do tipo de relação do item de trabalho.

function getRelationType(relation: string): Promise<WorkItemRelationType>

Parâmetros

relation: string

O nome da relação

Devoluções

Promise<WorkItemRelationType>

getRelationTypes()

Obtém os tipos de relação do item de trabalho.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Devoluções

Promise<WorkItemRelationType[]>

getReportingLinksByLinkType(string, string[], string[], string, Date)

Obter um lote de ligações de itens de trabalho

function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>

Parâmetros

project: string

ID do Projeto ou nome do projeto

linkTypes: string[]

Uma lista de tipos para filtrar os resultados para tipos de ligação específicos. Omita este parâmetro para obter ligações de itens de trabalho de todos os tipos de ligação.

types: string[]

Uma lista de tipos para filtrar os resultados para tipos de itens de trabalho específicos. Omita este parâmetro para obter ligações de itens de trabalho de todos os tipos de itens de trabalho.

continuationToken: string

Especifica o continuationToken para iniciar o lote a partir de. Omita este parâmetro para obter o primeiro lote de ligações.

startDateTime: Date

Data/hora a utilizar como ponto de partida para alterações de ligação. Apenas serão devolvidas as alterações de ligação que ocorreram após essa data/hora. Não é possível utilizar em conjunto com o parâmetro "marca d'água".

Devoluções

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Devolve um item de trabalho totalmente hidratado para a revisão pedida

function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>

Parâmetros

id: number

revisionNumber: number

project: string

ID do Projeto ou nome do projeto

expand: WorkItemExpand

Devoluções

Promise<WorkItem>

getRevisions(number, string, number, number, WorkItemExpand)

Devolve a lista de revisões de itens de trabalho totalmente hidratados, paginadas.

function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>

Parâmetros

id: number

project: string

ID do Projeto ou nome do projeto

top: number

skip: number

expand: WorkItemExpand

Devoluções

Promise<WorkItem[]>

getRootNodes(string, number)

Obtém nós de classificação de raiz no projeto.

function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

depth: number

Profundidade das crianças a obter.

Devoluções

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Obtém o modelo com o ID especificado

function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Parâmetros

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

templateId: string

ID do Modelo

Devoluções

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Obtém o modelo

function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

workitemtypename: string

Opcional, Quando especificado devolve modelos para um determinado tipo de item de Trabalho.

Devoluções

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Devolve uma única atualização para um item de trabalho

function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>

Parâmetros

id: number

updateNumber: number

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Devolve os deltas entre revisões de itens de trabalho

function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>

Parâmetros

id: number

project: string

ID do Projeto ou nome do projeto

top: number

skip: number

Devoluções

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Obtenha a lista de itens de trabalho que monitorizam os tipos de ligação de artefactos de saída.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Devoluções

Promise<WorkArtifactLink[]>

getWorkItem(number, string, string[], Date, WorkItemExpand)

Devolve um único item de trabalho.

function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Parâmetros

id: number

O ID do item de trabalho

project: string

ID do Projeto ou nome do projeto

fields: string[]

Lista separada por vírgulas de campos pedidos

asOf: Date

Cadeia de hora de data asOf UTC

expand: WorkItemExpand

Os parâmetros de expansão para atributos de itens de trabalho. As opções possíveis são { Nenhum, Relações, Campos, Ligações, Tudo }.

Devoluções

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Obtenha um ícone de item de trabalho com o nome amigável e a cor do ícone.

function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>

Parâmetros

icon: string

O nome do ícone

color: string

A cor hexadecima de 6 dígitos para o ícone

v: number

A versão do ícone (utilizada apenas para a invalidação da cache)

Devoluções

Promise<WorkItemIcon>

getWorkItemIcons()

Obtenha uma lista de todos os ícones de itens de trabalho.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Devoluções

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Obtenha um ícone de item de trabalho com o nome amigável e a cor do ícone.

function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>

Parâmetros

icon: string

O nome do ícone

color: string

A cor hexadecima de 6 dígitos para o ícone

v: number

A versão do ícone (utilizada apenas para a invalidação da cache)

Devoluções

Promise<any>

getWorkItemIconXaml(string, string, number)

Obtenha um ícone de item de trabalho com o nome amigável e a cor do ícone.

function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>

Parâmetros

icon: string

O nome do ícone

color: string

A cor hexadecima de 6 dígitos para o ícone

v: number

A versão do ícone (utilizada apenas para a invalidação da cache)

Devoluções

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Devolve o estado seguinte nos IDs de item de trabalho especificados.

function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>

Parâmetros

ids: number[]

lista de IDs de itens de trabalho

action: string

possíveis ações. Atualmente, apenas suporta a entrada de verificação

Devoluções

Promise<WorkItemNextStateOnTransition[]>

getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)

Devolve uma lista de itens de trabalho (Máximo de 200)

function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>

Parâmetros

ids: number[]

A lista separada por vírgulas de IDs de itens de trabalho pedidos. (Máximo de 200 IDs permitidos).

project: string

ID do Projeto ou nome do projeto

fields: string[]

Lista separada por vírgulas de campos pedidos

asOf: Date

Cadeia de hora de data asOf UTC

expand: WorkItemExpand

Os parâmetros de expansão para atributos de itens de trabalho. As opções possíveis são { Nenhum, Relações, Campos, Ligações, Tudo }.

errorPolicy: WorkItemErrorPolicy

O sinalizador para controlar a política de erros num pedido de itens de trabalho em massa. As opções possíveis são {Fail, Omit}.

Devoluções

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Obtém itens de trabalho para uma lista de IDs de itens de trabalho (Máximo de 200)

function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>

Parâmetros

workItemGetRequest: WorkItemBatchGetRequest

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItem[]>

getWorkItemStateColors(string[])

APENAS INTERNO: será utilizado para a experiência profissional A minha conta. Obter a cor de estado do tipo de item de trabalho para vários projetos

function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>

Parâmetros

projectNames: string[]

Devoluções

Promise<ProjectWorkItemStateColors[]>

getWorkItemTemplate(string, string, string, Date, WorkItemExpand)

Devolve um único item de trabalho de um modelo.

function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Parâmetros

project: string

ID do Projeto ou nome do projeto

type: string

O nome do tipo de item de trabalho

fields: string

Lista separada por vírgulas de campos pedidos

asOf: Date

Cadeia de hora de data asOf UTC

expand: WorkItemExpand

Os parâmetros de expansão para atributos de itens de trabalho. As opções possíveis são { Nenhum, Relações, Campos, Ligações, Tudo }.

Devoluções

Promise<WorkItem>

getWorkItemType(string, string)

Devolve uma definição de tipo de item de trabalho.

function getWorkItemType(project: string, type: string): Promise<WorkItemType>

Parâmetros

project: string

ID do Projeto ou nome do projeto

type: string

Nome do tipo de item de trabalho

Devoluções

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Obtenha todas as categorias de tipo de item de trabalho.

function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Obtenha categoria de tipo de item de trabalho específica por nome.

function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>

Parâmetros

project: string

ID do Projeto ou nome do projeto

category: string

O nome da categoria

Devoluções

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

APENAS INTERNO: é utilizado para fornecedores de cores e ícones. Obter a cor do tipo de sagacidade para vários projetos

function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

Parâmetros

projectNames: string[]

Devoluções

Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

getWorkItemTypeColors(string[])

APENAS INTERNO: será utilizado para a experiência profissional A minha conta. Obter a cor do tipo de sagacidade para vários projetos

function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>

Parâmetros

projectNames: string[]

Devoluções

Promise<{ key: string, value: WorkItemTypeColor[] }[]>

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Obtenha uma lista de campos para um tipo de item de trabalho com referências detalhadas.

function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

type: string

Tipo de item de trabalho.

expand: WorkItemTypeFieldsExpandLevel

Expanda o nível para a resposta da API. Propriedades: para incluir valores permitidos, valor predefinido, isRequired, etc. como parte da resposta; Nenhum: para ignorar estas propriedades.

Devoluções

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Obtenha um campo para um tipo de item de trabalho com referências detalhadas.

function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>

Parâmetros

project: string

ID do Projeto ou nome do projeto

type: string

Tipo de item de trabalho.

field: string

expand: WorkItemTypeFieldsExpandLevel

Expanda o nível para a resposta da API. Propriedades: para incluir valores permitidos, valor predefinido, isRequired, etc. como parte da resposta; Nenhum: para ignorar estas propriedades.

Devoluções

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Devolve a lista de tipos de itens de trabalho

function getWorkItemTypes(project: string): Promise<WorkItemType[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Devolve os nomes de estado e as cores de um tipo de item de trabalho.

function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>

Parâmetros

project: string

ID do Projeto ou nome do projeto

type: string

O nome do estado

Devoluções

Promise<WorkItemStateColor[]>

queryById(string, string, string, boolean, number)

Obtém os resultados da consulta com o ID da consulta.

function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Parâmetros

id: string

O ID da consulta.

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

timePrecision: boolean

Quer utilize ou não a precisão de tempo.

top: number

O número máximo de resultados a devolver.

Devoluções

Promise<WorkItemQueryResult>

queryByWiql(Wiql, string, string, boolean, number)

Obtém os resultados da consulta, dado o WIQL.

function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Parâmetros

wiql: Wiql

A consulta que contém o WIQL.

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

timePrecision: boolean

Quer utilize ou não a precisão de tempo.

top: number

O número máximo de resultados a devolver.

Devoluções

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

As consultas funcionam com itens ligados a uma determinada lista de URI de artefactos.

function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>

Parâmetros

artifactUriQuery: ArtifactUriQuery

Define uma lista de URI de artefactos para consultar itens de trabalho.

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<ArtifactUriQueryResult>

readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)

Obter um lote de revisões de itens de trabalho com a opção de incluir itens eliminados

function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>

Parâmetros

project: string

ID do Projeto ou nome do projeto

fields: string[]

Uma lista de campos a devolver em revisões de itens de trabalho. Omita este parâmetro para obter todos os campos reportáveis.

types: string[]

Uma lista de tipos para filtrar os resultados para tipos de itens de trabalho específicos. Omita este parâmetro para obter revisões de itens de trabalho de todos os tipos de itens de trabalho.

continuationToken: string

Especifica a marca d'água a partir da qual iniciar o lote. Omita este parâmetro para obter o primeiro lote de revisões.

startDateTime: Date

Data/hora a utilizar como ponto de partida para revisões, todas as revisões ocorrerão após esta data/hora. Não é possível utilizar em conjunto com o parâmetro "marca d'água".

includeIdentityRef: boolean

Devolver uma referência de identidade em vez de um valor de cadeia para campos de identidade.

includeDeleted: boolean

Especifique se o item eliminado deve ser devolvido.

includeTagRef: boolean

Especifique se os objetos de etiqueta devem ser devolvidos para o campo System.Tags.

includeLatestOnly: boolean

Devolver apenas as revisões mais recentes dos itens de trabalho, ignorando todas as revisões históricas

expand: ReportingRevisionsExpand

Devolver todos os campos em revisões de itens de trabalho, incluindo campos de texto longos que não são devolvidos por predefinição

includeDiscussionChangesOnly: boolean

Devolver apenas as revisões dos itens de trabalho, em que apenas o campo histórico foi alterado

maxPageSize: number

O número máximo de resultados a devolver neste lote

Devoluções

Promise<ReportingWorkItemRevisionsBatch>

readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)

Obter um lote de revisões de itens de trabalho. Este pedido poderá ser utilizado se a sua lista de campos for suficientemente grande para que possa executar o URL acima do limite de comprimento.

function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>

Parâmetros

filter: ReportingWorkItemRevisionsFilter

Um objeto que contém definições de pedido: filtro de campo, filtro de tipo, formato de identidade

project: string

ID do Projeto ou nome do projeto

continuationToken: string

Especifica a marca d'água a partir da qual iniciar o lote. Omita este parâmetro para obter o primeiro lote de revisões.

startDateTime: Date

Data/hora a utilizar como ponto de partida para revisões, todas as revisões ocorrerão após esta data/hora. Não é possível utilizar em conjunto com o parâmetro "marca d'água".

expand: ReportingRevisionsExpand

Devoluções

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Substituir conteúdo do modelo

function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Parâmetros

templateContent: WorkItemTemplate

Conteúdo do modelo a substituir por

project: string

ID do Projeto ou nome do projeto

team: string

ID da equipa ou nome da equipa

templateId: string

ID do modelo

Devoluções

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Restaura o item de trabalho eliminado da Reciclagem.

function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>

Parâmetros

payload: WorkItemDeleteUpdate

Paylod com instruções para atualizar o sinalizador IsDeleted para falso

id: number

ID do item de trabalho a restaurar

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemDelete>

searchQueries(string, string, number, QueryExpand, boolean)

Procura todas as consultas às quais o utilizador tem acesso no projeto atual

function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>

Parâmetros

project: string

ID do Projeto ou nome do projeto

filter: string

O texto para filtrar as consultas com.

top: number

O número de consultas a devolver (a predefinição é 50 e o máximo é 200).

expand: QueryExpand

includeDeleted: boolean

Incluir consultas e pastas eliminadas

Devoluções

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Método RESTful para enviar correio para itens de trabalho selecionados/consultados.

function sendMail(body: SendMailBody, project?: string): Promise<void>

Parâmetros

body: SendMailBody

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Atualizar um nó de classificação existente.

function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Parâmetros

postedNode: WorkItemClassificationNode

Nó para criar ou atualizar.

project: string

ID do Projeto ou nome do projeto

structureGroup: TreeStructureGroup

Grupo estrutura do nó de classificação, área ou iteração.

path: string

Caminho do nó de classificação.

Devoluções

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Atualizar um campo.

function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Parâmetros

payload: UpdateWorkItemField

Payload contém o valor pretendido das propriedades do campo

fieldNameOrRefName: string

Nome/nome de referência do campo a atualizar

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Atualizar uma consulta ou uma pasta. Isto permite-lhe atualizar, mudar o nome e mover consultas e pastas.

function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>

Parâmetros

queryUpdate: QueryHierarchyItem

A consulta a atualizar.

project: string

ID do Projeto ou nome do projeto

query: string

O ID ou caminho para a consulta atualizar.

undeleteDescendants: boolean

Desdele as crianças desta pasta. É importante ter em atenção que isto não trará de volta as alterações de permissão que foram aplicadas anteriormente aos descendentes.

Devoluções

Promise<QueryHierarchyItem>

updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)

Atualizações um único item de trabalho.

function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Parâmetros

document: JsonPatchDocument

O documento de Patch JSON que representa a atualização

id: number

O ID do item de trabalho a atualizar

project: string

ID do Projeto ou nome do projeto

validateOnly: boolean

Indicar se apenas pretende validar as alterações sem guardar o item de trabalho

bypassRules: boolean

Não impor as regras de tipo de item de trabalho nesta atualização

suppressNotifications: boolean

Não acione notificações para esta alteração

expand: WorkItemExpand

Os parâmetros de expansão para atributos de itens de trabalho. As opções possíveis são { Nenhum, Relações, Campos, Ligações, Tudo }.

Devoluções

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Adicionar/atualizar um tipo de item de trabalho

function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>

Parâmetros

updateModel: WorkItemTypeTemplateUpdateModel

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<ProvisioningResult>

Partilhar via

WorkItemTrackingRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

WorkItemTrackingRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

createAttachment(any, string, string, string, string)

Parâmetros

Devoluções

createField(WorkItemField, string)

Parâmetros

Devoluções

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parâmetros

Devoluções

createQuery(QueryHierarchyItem, string, string, boolean)

Parâmetros

Devoluções

createTemplate(WorkItemTemplate, string, string)

Parâmetros

Devoluções

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Parâmetros

Devoluções

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parâmetros

Devoluções

deleteField(string, string)

Parâmetros

Devoluções

deleteQuery(string, string)

Parâmetros

Devoluções

deleteTemplate(string, string, string)

Parâmetros

Devoluções

deleteWorkItem(number, string, boolean)

Parâmetros

Devoluções

destroyWorkItem(number, string)

Parâmetros

Devoluções

exportWorkItemTypeDefinition(string, string, boolean)

Parâmetros

Devoluções

getAccountMyWorkData(QueryOption)

Parâmetros

Devoluções

getAttachmentContent(string, string, string, boolean)

Parâmetros

Devoluções

getAttachmentZip(string, string, string, boolean)

Parâmetros

Devoluções

getClassificationNode(string, TreeStructureGroup, string, number)

Parâmetros

Devoluções

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Parâmetros

Devoluções

getComment(number, number, string)

Parâmetros

Devoluções

getComments(number, string, number, number, CommentSortOrder)

Parâmetros

Devoluções

getDeletedWorkItem(number, string)

Parâmetros

Devoluções

getDeletedWorkItems(number[], string)

Parâmetros

Devoluções

getDeletedWorkItemShallowReferences(string)

Parâmetros