WorkItemTrackingRestClient class

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends: RestClientBase

Construtores

WorkItemTrackingRestClient(IVssRestClientOptions)

Propriedades

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 nó de classificação 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)	Exclua um nó de classificação existente.
deleteField(string, string)	Exclui o campo. Para cancelar a exclusão de um arquivo, consulte a API "Atualizar campo".
deleteQuery(string, string)	Excluir uma consulta ou uma pasta. Isso exclui qualquer alteração de permissão na consulta ou pasta excluída e qualquer um de seus descendentes, se for uma pasta. É importante notar que as alterações de permissão excluídas não podem ser recuperadas após a exclusão da consulta ou pasta.
deleteTemplate(string, string, string)	Exclui o modelo com determinada id
deleteWorkItem(number, string, boolean)	Exclui o item de trabalho especificado e o envia para a Lixeira, para que possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro destroy tiver sido definido como true, ele destrói o item de trabalho permanentemente. AVISO: Se o parâmetro destroy estiver definido como true, os itens de trabalho excluídos por este comando NÃO irão para a lixeira e não há como restaurá-los/recuperá-los após a exclusão. Recomenda-se NÃO usar este parâmetro. Se o fizer, utilize este parâmetro com extrema cautela.
destroyWorkItem(number, string)	Destrói o item de trabalho especificado permanentemente da Lixeira. Esta ação não pode ser desfeita.
exportWorkItemTypeDefinition(string, string, boolean)	Exportar tipo de item de trabalho
getAccountMyWorkData(QueryOption)	APENAS INTERNO: USADO PELA CONTA MINHA PÁGINA DE TRABALHO. Isso retorna detalhes de itens de trabalho Fazendo, Concluído, Segue e atividade.
getAttachmentContent(string, string, string, boolean)	Descarrega um anexo.
getAttachmentZip(string, string, string, boolean)	Descarrega 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 raiz ou lista de nós de classificação para uma determinada lista de ids de nós, para um determinado projeto. Caso o parâmetro ids seja fornecido, você obterá uma lista de nós de classificação para esses ids. Caso contrário, você obterá nós de classificação 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 da revisão especificada.
getDeletedWorkItem(number, string)	Obtém um item de trabalho excluído da Lixeira.
getDeletedWorkItems(number[], string)	Obtém os itens de trabalho da lixeira, cujas IDs foram especificadas nos parâmetros
getDeletedWorkItemShallowReferences(string)	Obtém uma lista dos IDs e URLs dos itens de trabalho excluídos na Lixeira.
getField(string, string)	Obtém informações sobre um campo específico.
getFields(string, GetFieldsExpand)	Retorna informações para todos os campos. O parâmetro ID/name do projeto é opcional.
getQueries(string, QueryExpand, number, boolean)	Obtém as consultas raiz e seus filhos
getQueriesBatch(QueryBatchGetRequest, string)	Obtém uma lista de consultas por ids (máximo 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Recupera uma consulta individual e seus filhos
getQueryResultCount(string, string, string, boolean, number)	Obtém os resultados da consulta com a ID da consulta.
getRecentActivityData()	Obtém atividades recentes de item de trabalho
getRecentMentions()	APENAS INTERNO: USADO PELA CONTA MINHA PÁGINA DE TRABALHO.
getRelationType(string)	Obtém a definição de tipo de relação de item de trabalho.
getRelationTypes()	Obtém os tipos de relação de item de trabalho.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Obter um lote de links de item de trabalho
getRevision(number, number, string, WorkItemExpand)	Devolve um item de trabalho totalmente hidratado para a revisão solicitada
getRevisions(number, string, number, number, WorkItemExpand)	Retorna a lista de revisões de item de trabalho totalmente hidratadas, paginadas.
getRootNodes(string, number)	Obtém nós de classificação raiz no projeto.
getTemplate(string, string, string)	Obtém o modelo com id especificado
getTemplates(string, string, string)	Obtém modelo
getUpdate(number, number, string)	Retorna uma única atualização para um item de trabalho
getUpdates(number, string, number, number)	Devolve os deltas entre revisões de item de trabalho
getWorkArtifactLinkTypes()	Obtenha a lista de tipos de link de artefato de saída de rastreamento de item de trabalho.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Retorna 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 item 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)	Retorna o próximo estado nas IDs de item de trabalho fornecidas.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Retorna uma lista de itens de trabalho (máximo 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Obtém itens de trabalho para uma lista de ids de item de trabalho (Máximo 200)
getWorkItemStateColors(string[])	APENAS INTERNO: Será usado para Minha experiência de trabalho na conta. Obter a cor do estado do tipo de item de trabalho para vários projetos
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Retorna um único item de trabalho de um modelo.
getWorkItemType(string, string)	Retorna 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 específica de tipo de item de trabalho por nome.
getWorkItemTypeColorAndIcons(string[])	APENAS INTERNO: É usado para provedores de cores e ícones. Obtenha a cor do tipo de sagacidade para vários projetos
getWorkItemTypeColors(string[])	APENAS INTERNO: Será usado para Minha experiência de trabalho na conta. Obtenha 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)	Retorna a lista de tipos de item de trabalho
getWorkItemTypeStates(string, string)	Retorna 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 a ID da consulta.
queryByWiql(Wiql, string, string, boolean, number)	Obtém os resultados da consulta dado seu WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Consulta itens de trabalho vinculados a uma determinada lista de URI de artefato.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Obter um lote de revisões de item de trabalho com a opção de incluir itens excluídos
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Obtenha um lote de revisões de itens de trabalho. Esta solicitação pode ser usada se sua lista de campos for grande o suficiente para que ele 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 excluído da Lixeira.
searchQueries(string, string, number, QueryExpand, boolean)	Pesquisa todas as consultas às quais o usuário tem acesso no projeto atual
sendMail(SendMailBody, string)	Método RESTful para enviar email para itens de trabalho selecionados/consultados.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Atualize um nó de classificação existente.
updateField(UpdateWorkItemField, string, string)	Atualizar um campo.
updateQuery(QueryHierarchyItem, string, string, boolean)	Atualize uma consulta ou uma pasta. Isso permite que você atualize, renomeie e mova consultas e pastas.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Atualiza 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 para carregar

project: string

ID do projeto ou nome do projeto

fileName: string

O nome do arquivo

uploadType: string

Tipo de upload de anexo: Simples ou Chunked

areaPath: string

Caminho da área do projeto-alvo

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 nó de classificação 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 de estrutura do nó, área ou iteração de classificaçã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 ser criada.

project: string

ID do projeto ou nome do projeto

query: string

A ID pai ou o caminho sob o qual a consulta deve ser criada.

validateWiqlOnly: boolean

Se você quiser apenas validar sua consulta WIQL sem realmente criar uma, defina-a como true. O valor padrã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 JSON Patch 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 ser criado

validateOnly: boolean

Indique se deseja validar apenas as alterações sem salvar o item de trabalho

bypassRules: boolean

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

suppressNotifications: boolean

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

expand: WorkItemExpand

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

Devoluções

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Exclua 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 de estrutura do nó, área ou iteração de classificaçã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)

Exclui o campo. Para cancelar a exclusão de um arquivo, consulte a API "Atualizar campo".

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

Parâmetros

fieldNameOrRefName: string

Nome simples do campo ou nome de referência

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

deleteQuery(string, string)

Excluir uma consulta ou uma pasta. Isso exclui qualquer alteração de permissão na consulta ou pasta excluída e qualquer um de seus descendentes, se for uma pasta. É importante notar que as alterações de permissão excluídas não podem ser recuperadas após a exclusão da consulta ou 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 ser excluída.

Devoluções

Promise<void>

deleteTemplate(string, string, string)

Exclui o modelo com determinada id

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)

Exclui o item de trabalho especificado e o envia para a Lixeira, para que possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro destroy tiver sido definido como true, ele destrói o item de trabalho permanentemente. AVISO: Se o parâmetro destroy estiver definido como true, os itens de trabalho excluídos por este comando NÃO irão para a lixeira e não há como restaurá-los/recuperá-los após a exclusão. Recomenda-se NÃO usar este parâmetro. Se o fizer, utilize este parâmetro com extrema cautela.

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

Parâmetros

id: number

ID do item de trabalho a ser excluído

project: string

ID do projeto ou nome do projeto

destroy: boolean

Parâmetro opcional, se definido como true, o item de trabalho é excluído permanentemente. Atenção: a ação de destruição é PERMANENTE e não pode ser desfeita.

Devoluções

Promise<WorkItemDelete>

destroyWorkItem(number, string)

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

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: USADO PELA CONTA MINHA PÁGINA DE TRABALHO. Isso retorna detalhes de itens de trabalho Fazendo, Concluído, Segue e atividade.

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

Parâmetros

queryOption: QueryOption

Devoluções

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Descarrega 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 definido como <c>true</c> descarregue sempre o anexo

Devoluções

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Descarrega 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 definido como <c>true</c> descarregue 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 de estrutura do nó, área ou iteração de classificação.

path: string

Caminho do nó de classificação.

depth: number

Profundidade das crianças para buscar.

Devoluções

Promise<WorkItemClassificationNode>

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

Obtém nós de classificação raiz ou lista de nós de classificação para uma determinada lista de ids de nós, para um determinado projeto. Caso o parâmetro ids seja fornecido, você obterá uma lista de nós de classificação para esses ids. Caso contrário, você obterá nós de classificação 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 inteira separados por vírgula. Não é necessário, se você quiser nós raiz.

depth: number

Profundidade das crianças para buscar.

errorPolicy: ClassificationNodesErrorPolicy

Sinalizar para lidar com 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 precisa ser buscado

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 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 buscados (o padrão é 1)

top: number

O número de comentários a serem retornados (o padrão é 200)

order: CommentSortOrder

Ascendente ou decrescente por id de revisão (o padrão é ascendente)

Devoluções

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Obtém um item de trabalho excluído da Lixeira.

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

Parâmetros

id: number

ID do item de trabalho a ser devolvido

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Obtém os itens de trabalho da lixeira, cujas IDs foram especificadas 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 excluídos a serem retornados

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Obtém uma lista dos IDs e URLs dos itens de trabalho excluídos na Lixeira.

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 sobre um campo específico.

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

Parâmetros

fieldNameOrRefName: string

Nome simples do campo ou nome de referência

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

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

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

Parâmetros

project: string

ID do projeto ou nome do projeto

expand: GetFieldsExpand

Use ExtensionFields para incluir campos de extensão, caso contrário, exclua-os. A menos que o sinalizador de recurso para esse parâmetro esteja habilitado, os campos de extensão serão sempre incluídos.

Devoluções

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Obtém as consultas raiz e 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 caracteres de consulta (wiql), cláusulas, colunas de resultados da consulta e opções de classificação nos resultados.

depth: number

Na pasta de consultas, retorne consultas filho e pastas com essa profundidade.

includeDeleted: boolean

Incluir consultas e pastas excluídas

Devoluções

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Obtém uma lista de consultas por ids (máximo 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)

Recupera uma consulta individual e seus filhos

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 caracteres de consulta (wiql), cláusulas, colunas de resultados da consulta e opções de classificação nos resultados.

depth: number

Na pasta de consultas, retorne consultas filho e pastas com essa profundidade.

includeDeleted: boolean

Incluir consultas e pastas excluídas

useIsoDateFormat: boolean

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

Devoluções

Promise<QueryHierarchyItem>

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

Obtém os resultados da consulta com a 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

Utilizar ou não a precisão temporal.

top: number

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

Devoluções

Promise<number>

getRecentActivityData()

Obtém atividades recentes de item de trabalho

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Devoluções

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

APENAS INTERNO: USADO PELA CONTA MINHA PÁGINA DE TRABALHO.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Devoluções

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Obtém a definição de tipo de relação de 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 de item de trabalho.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Devoluções

Promise<WorkItemRelationType[]>

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

Obter um lote de links de item 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 link específicos. Omita esse parâmetro para obter links de item de trabalho de todos os tipos de link.

types: string[]

Uma lista de tipos para filtrar os resultados para tipos de item de trabalho específicos. Omita esse parâmetro para obter links de item de trabalho de todos os tipos de item de trabalho.

continuationToken: string

Especifica o continuationToken a partir do qual iniciar o lote. Omita esse parâmetro para obter o primeiro lote de links.

startDateTime: Date

Data/hora a utilizar como ponto de partida para alterações de ligação. Somente as alterações de link que ocorreram após essa data/hora serão retornadas. Não pode ser usado 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 solicitada

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)

Retorna a lista de revisões de item de trabalho totalmente hidratadas, 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 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 para buscar.

Devoluções

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Obtém o modelo com 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 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 retorna modelos para determinado tipo de item de trabalho.

Devoluções

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Retorna 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 item 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 tipos de link de artefato de saída de rastreamento de item de trabalho.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Devoluções

Promise<WorkArtifactLink[]>

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

Retorna um único item de trabalho.

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

Parâmetros

id: number

A ID do item de trabalho

project: string

ID do projeto ou nome do projeto

fields: string[]

Lista de campos solicitados separada por vírgulas

asOf: Date

Cadeia de caracteres de data e hora AsOf UTC

expand: WorkItemExpand

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

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 hexadecimal de 6 dígitos para o ícone

v: number

A versão do ícone (usada apenas para invalidação de cache)

Devoluções

Promise<WorkItemIcon>

getWorkItemIcons()

Obtenha uma lista de todos os ícones de item 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 hexadecimal de 6 dígitos para o ícone

v: number

A versão do ícone (usada apenas para invalidação de 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 hexadecimal de 6 dígitos para o ícone

v: number

A versão do ícone (usada apenas para invalidação de cache)

Devoluções

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Retorna o próximo estado nas IDs de item de trabalho fornecidas.

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

Parâmetros

ids: number[]

Lista de IDs de item de trabalho

action: string

ações possíveis. Atualmente só suporta check-in

Devoluções

Promise<WorkItemNextStateOnTransition[]>

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

Retorna uma lista de itens de trabalho (máximo 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 item de trabalho solicitado. (Máximo de 200 ids permitidos).

project: string

ID do projeto ou nome do projeto

fields: string[]

Lista de campos solicitados separada por vírgulas

asOf: Date

Cadeia de caracteres de data e hora AsOf UTC

expand: WorkItemExpand

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

errorPolicy: WorkItemErrorPolicy

O sinalizador para controlar a política de erro em uma solicitação de itens de trabalho obter 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 item de trabalho (Máximo 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á usado para Minha experiência de trabalho na conta. Obter a cor do 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)

Retorna 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 de campos solicitados separada por vírgulas

asOf: Date

Cadeia de caracteres de data e hora AsOf UTC

expand: WorkItemExpand

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

Devoluções

Promise<WorkItem>

getWorkItemType(string, string)

Retorna 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 específica de tipo de item de trabalho 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: É usado para provedores de cores e ícones. Obtenha 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á usado para Minha experiência de trabalho na conta. Obtenha 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 padrão, 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 padrão, isRequired etc. como parte da resposta; Nenhum: para ignorar estas propriedades.

Devoluções

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Retorna a lista de tipos de item 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)

Retorna 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 a 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

Utilizar ou não a precisão temporal.

top: number

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

Devoluções

Promise<WorkItemQueryResult>

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

Obtém os resultados da consulta dado seu 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

Utilizar ou não a precisão temporal.

top: number

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

Devoluções

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Consulta itens de trabalho vinculados a uma determinada lista de URI de artefato.

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

Parâmetros

artifactUriQuery: ArtifactUriQuery

Define uma lista de URI de artefato 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 item de trabalho com a opção de incluir itens excluídos

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 serem retornados em revisões de item de trabalho. Omita esse parâmetro para obter todos os campos relatáveis.

types: string[]

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

continuationToken: string

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

startDateTime: Date

Data/hora a utilizar como ponto de partida para as revisões, todas as revisões ocorrerão após essa data/hora. Não pode ser usado em conjunto com o parâmetro 'marca d'água'.

includeIdentityRef: boolean

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

includeDeleted: boolean

Especifique se o item excluído deve ser devolvido.

includeTagRef: boolean

Especifique se os objetos de tag devem ser retornados para o campo System.Tags.

includeLatestOnly: boolean

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

expand: ReportingRevisionsExpand

Retornar todos os campos em revisões de item de trabalho, incluindo campos de texto longos que não são retornados por padrão

includeDiscussionChangesOnly: boolean

Retornar somente as revisões de itens de trabalho, onde apenas o campo histórico foi alterado

maxPageSize: number

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

Devoluções

Promise<ReportingWorkItemRevisionsBatch>

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

Obtenha um lote de revisões de itens de trabalho. Esta solicitação pode ser usada se sua lista de campos for grande o suficiente para que ele 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 configurações de solicitação: 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 o lote será iniciado. Omita esse parâmetro para obter o primeiro lote de revisões.

startDateTime: Date

Data/hora a utilizar como ponto de partida para as revisões, todas as revisões ocorrerão após essa data/hora. Não pode ser usado 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 ser substituído 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 excluído da Lixeira.

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

Parâmetros

payload: WorkItemDeleteUpdate

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

id: number

ID do item de trabalho a ser restaurado

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<WorkItemDelete>

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

Pesquisa todas as consultas às quais o usuário 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 com o qual filtrar as consultas.

top: number

O número de consultas a serem retornadas (o padrão é 50 e o máximo é 200).

expand: QueryExpand

includeDeleted: boolean

Incluir consultas e pastas excluídas

Devoluções

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Método RESTful para enviar email 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)

Atualize 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 de estrutura do nó, área ou iteração de classificaçã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

A carga útil contém o valor desejado 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)

Atualize uma consulta ou uma pasta. Isso permite que você atualize, renomeie e mova consultas e pastas.

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

Parâmetros

queryUpdate: QueryHierarchyItem

A consulta a ser atualizada.

project: string

ID do projeto ou nome do projeto

query: string

O ID ou caminho para a consulta a ser atualizada.

undeleteDescendants: boolean

Cancele a exclusão dos filhos desta pasta. É importante notar que isso não trará de volta as alterações de permissão que foram anteriormente aplicadas aos descendentes.

Devoluções

Promise<QueryHierarchyItem>

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

Atualiza 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 do patch JSON que representa a atualização

id: number

A id do item de trabalho a ser atualizado

project: string

ID do projeto ou nome do projeto

validateOnly: boolean

Indique se deseja validar apenas as alterações sem salvar o item de trabalho

bypassRules: boolean

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

suppressNotifications: boolean

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

expand: WorkItemExpand

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

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>

Comentários

Esta página foi útil?

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