WorkItemTrackingRestClient class

Referência

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

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)	Criar ou atualizar 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 desmarcar um arquivo arquivado, confira API "Atualizar Campo".
deleteQuery(string, string)	Exclua 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 observar que as alterações de permissão excluídas não podem ser recuperadas ao desmarcando a consulta ou a pasta.
deleteTemplate(string, string, string)	Exclui o modelo com a ID fornecida
deleteWorkItem(number, string, boolean)	Exclui o item de trabalho especificado e o envia para a Lixeira, para que ele possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro destroy tiver sido definido como true, ele destruirá o item de trabalho permanentemente. AVISO: se o parâmetro destroy for definido como true, os itens de trabalho excluídos por esse comando NÃO irão para a lixeira e não haverá como restaurá-los/recuperá-los após a exclusão. É recomendável NÃO usar esse parâmetro. Se você fizer isso, use esse parâmetro com extrema cautela.
destroyWorkItem(number, string)	Destrói o item de trabalho especificado permanentemente da Lixeira. Essa ação não pode ser desfeita.
exportWorkItemTypeDefinition(string, string, boolean)	Exportar tipo de item de trabalho
getAccountMyWorkData(QueryOption)	SOMENTE INTERNO: USADO PELA CONTA MINHA PÁGINA DE TRABALHO. Isso retorna os detalhes dos itens de trabalho Doing, Done, Follows e activity.
getAttachmentContent(string, string, string, boolean)	Baixa um anexo.
getAttachmentZip(string, string, string, boolean)	Baixa 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 essas 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 das IDs e das 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/nome 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 de 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 considerando a ID da consulta.
getRecentActivityData()	Obtém atividades recentes do item de trabalho
getRecentMentions()	SOMENTE 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)	Retorna um item de trabalho totalmente hidratado para a revisão solicitada
getRevisions(number, string, number, number, WorkItemExpand)	Retorna a lista de revisões de itens de trabalho totalmente hidratados, paginadas.
getRootNodes(string, number)	Obtém nós de classificação raiz no projeto.
getTemplate(string, string, string)	Obtém o modelo com a ID especificada
getTemplates(string, string, string)	Obtém o modelo
getUpdate(number, number, string)	Retorna uma única atualização para um item de trabalho
getUpdates(number, string, number, number)	Retorna os deltas entre revisões de item de trabalho
getWorkArtifactLinkTypes()	Obtenha a lista de itens de trabalho que acompanham tipos de link de artefato de saída.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Retorna um único item de trabalho.
getWorkItemIconJson(string, string, number)	Obtenha um ícone de item de trabalho, considerando 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, considerando o nome amigável e a cor do ícone.
getWorkItemIconXaml(string, string, number)	Obtenha um ícone de item de trabalho, considerando 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 de 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Obtém itens de trabalho para uma lista de IDs de item de trabalho (máximo de 200)
getWorkItemStateColors(string[])	SOMENTE INTERNO: ele será usado para a experiência de trabalho minha 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)	Obter 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[])	SOMENTE INTERNO: é usado para provedores de cores e ícones. Obter a cor do tipo wit para vários projetos
getWorkItemTypeColors(string[])	SOMENTE INTERNO: ele será usado para a experiência de trabalho minha conta. Obter a cor do tipo wit 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 considerando a ID da consulta.
queryByWiql(Wiql, string, string, boolean, number)	Obtém os resultados da consulta considerando seu WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Consultas 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 item de trabalho. Essa solicitação poderá ser usada se sua lista de campos for grande o suficiente para que ela possa executar a URL acima do limite de comprimento.
replaceTemplate(WorkItemTemplate, string, string, string)	Substituir o 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 emails 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. Isso permite que você atualize, renomeie e mova 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 da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do 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 ser carregado

project: string

ID do projeto ou nome do projeto

fileName: string

O nome do arquivo

uploadType: string

Tipo de carregamento de anexo: simples ou em partes

areaPath: string

Caminho da área do projeto de destino

Retornos

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

Retornos

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Criar ou atualizar um nó de classificação existente.

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

Parâmetros

postedNode: WorkItemClassificationNode

Nó a ser criado ou atualizado.

project: string

ID do projeto ou nome do projeto

structureGroup: TreeStructureGroup

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

path: string

Caminho do nó de classificação.

Retornos

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 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 padrão é false.

Retornos

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 equipe ou nome da equipe

Retornos

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 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 ser criado

validateOnly: boolean

Indique se você só deseja validar as alterações sem salvar 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 nenhuma notificação para essa alteração

expand: WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.

Retornos

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ó 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.

Retornos

Promise<void>

deleteField(string, string)

Exclui o campo. Para desmarcar um arquivo arquivado, confira 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

Retornos

Promise<void>

deleteQuery(string, string)

Exclua 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 observar que as alterações de permissão excluídas não podem ser recuperadas ao desmarcando a consulta ou a 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.

Retornos

Promise<void>

deleteTemplate(string, string, string)

Exclui o modelo com a ID fornecida

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 equipe ou nome da equipe

templateId: string

ID do modelo

Retornos

Promise<void>

deleteWorkItem(number, string, boolean)

Exclui o item de trabalho especificado e o envia para a Lixeira, para que ele possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro destroy tiver sido definido como true, ele destruirá o item de trabalho permanentemente. AVISO: se o parâmetro destroy for definido como true, os itens de trabalho excluídos por esse comando NÃO irão para a lixeira e não haverá como restaurá-los/recuperá-los após a exclusão. É recomendável NÃO usar esse parâmetro. Se você fizer isso, use esse 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 será excluído permanentemente. Observação: a ação de destruição é PERMANENTE e não pode ser desfeita.

Retornos

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Destrói o item de trabalho especificado permanentemente da Lixeira. Essa 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

Retornos

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

Retornos

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

SOMENTE INTERNO: USADO PELA CONTA MINHA PÁGINA DE TRABALHO. Isso retorna os detalhes dos itens de trabalho Doing, Done, Follows e activity.

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

Parâmetros

queryOption: QueryOption

Retornos

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Baixa 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 arquivo

download: boolean

Se definido como <c>true</c> sempre baixar anexo

Retornos

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Baixa 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 arquivo

download: boolean

Se definido como <c>true</c> sempre baixar anexo

Retornos

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

path: string

Caminho do nó de classificação.

depth: number

Profundidade das crianças a serem buscadas.

Retornos

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 essas 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 de inteiro separados por vírgulas. Não é necessário, se você quiser nós raiz.

depth: number

Profundidade das crianças a serem buscadas.

errorPolicy: ClassificationNodesErrorPolicy

Sinalizador para lidar com erros na obtenção de alguns nós. As opções possíveis são Fail e Omitir.

Retornos

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

Retornos

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

Crescente ou decrescente por ID de revisão (o padrão é crescente)

Retornos

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 retornado

project: string

ID do projeto ou nome do projeto

Retornos

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

Retornos

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Obtém uma lista das IDs e das 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

Retornos

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

Retornos

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Retorna 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

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 sempre serão incluídos.

Retornos

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 resultado da consulta e opções de classificação nos resultados.

depth: number

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

includeDeleted: boolean

Incluir consultas e pastas excluídas

Retornos

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

Retornos

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 resultado da consulta e opções de classificação nos resultados.

depth: number

Na pasta de consultas, retorne consultas e pastas filho a 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 ISO 8601

Retornos

Promise<QueryHierarchyItem>

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

Obtém os resultados da consulta considerando a ID da consulta.

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

Parâmetros

id: string

A ID da consulta.

project: string

ID do projeto ou nome do projeto

team: string

ID da equipe ou nome da equipe

timePrecision: boolean

Se deve ou não usar a precisão de tempo.

top: number

O número máximo de resultados a serem retornados.

Retornos

Promise<number>

getRecentActivityData()

Obtém atividades recentes do item de trabalho

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Retornos

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

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

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Retornos

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

Retornos

Promise<WorkItemRelationType>

getRelationTypes()

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

function getRelationTypes(): Promise<WorkItemRelationType[]>

Retornos

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 do qual iniciar o lote. Omita esse parâmetro para obter o primeiro lote de links.

startDateTime: Date

Data/hora a ser usada como ponto de partida para alterações de link. 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 'watermark'.

Retornos

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Retorna 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

Retornos

Promise<WorkItem>

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

Retorna 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

Retornos

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 dos filhos a serem buscados.

Retornos

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Obtém o modelo com a ID especificada

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 equipe ou nome da equipe

templateId: string

ID do modelo

Retornos

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 equipe ou nome da equipe

workitemtypename: string

Opcional, Quando especificado retorna modelos para determinado tipo de item de trabalho.

Retornos

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

Retornos

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Retorna 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

Retornos

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Obtenha a lista de itens de trabalho que acompanham tipos de link de artefato de saída.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Retornos

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

asOf: Date

Cadeia de caracteres de data e hora UTC asOf

expand: WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.

Retornos

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Obtenha um ícone de item de trabalho, considerando 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)

Retornos

Promise<WorkItemIcon>

getWorkItemIcons()

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

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Retornos

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Obtenha um ícone de item de trabalho, considerando 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)

Retornos

Promise<any>

getWorkItemIconXaml(string, string, number)

Obtenha um ícone de item de trabalho, considerando 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)

Retornos

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ó dá suporte a check-in

Retornos

Promise<WorkItemNextStateOnTransition[]>

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

Retorna 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 item de trabalho solicitadas. (Máximo de 200 IDs permitidas).

project: string

ID do projeto ou nome do projeto

fields: string[]

Lista separada por vírgulas de campos solicitados

asOf: Date

Cadeia de caracteres de data e hora UTC asOf

expand: WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.

errorPolicy: WorkItemErrorPolicy

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

Retornos

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Obtém itens de trabalho para uma lista de IDs de item 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

Retornos

Promise<WorkItem[]>

getWorkItemStateColors(string[])

SOMENTE INTERNO: ele será usado para a experiência de trabalho minha 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[]

Retornos

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

asOf: Date

Cadeia de caracteres de data e hora UTC asOf

expand: WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.

Retornos

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

Retornos

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Obter 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

Retornos

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

Retornos

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

SOMENTE INTERNO: é usado para provedores de cores e ícones. Obter a cor do tipo wit para vários projetos

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

Parâmetros

projectNames: string[]

Retornos

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

getWorkItemTypeColors(string[])

SOMENTE INTERNO: ele será usado para a experiência de trabalho minha conta. Obter a cor do tipo wit para vários projetos

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

Parâmetros

projectNames: string[]

Retornos

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 essas propriedades.

Retornos

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 essas propriedades.

Retornos

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

Retornos

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

Retornos

Promise<WorkItemStateColor[]>

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

Obtém os resultados da consulta considerando a ID da consulta.

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

Parâmetros

id: string

A ID da consulta.

project: string

ID do projeto ou nome do projeto

team: string

ID da equipe ou nome da equipe

timePrecision: boolean

Se deve ou não usar a precisão de tempo.

top: number

O número máximo de resultados a serem retornados.

Retornos

Promise<WorkItemQueryResult>

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

Obtém os resultados da consulta considerando 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 equipe ou nome da equipe

timePrecision: boolean

Se deve ou não usar a precisão de tempo.

top: number

O número máximo de resultados a serem retornados.

Retornos

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Consultas 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

Retornos

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 reportá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 da qual iniciar o lote. Omita esse parâmetro para obter o primeiro lote de revisões.

startDateTime: Date

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

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 retornado.

includeTagRef: boolean

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

includeLatestOnly: boolean

Retornar apenas as revisões mais recentes dos 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, em que apenas o campo histórico foi alterado

maxPageSize: number

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

Retornos

Promise<ReportingWorkItemRevisionsBatch>

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

Obtenha um lote de revisões de item de trabalho. Essa solicitação poderá ser usada se sua lista de campos for grande o suficiente para que ela possa executar a 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 da qual iniciar o lote. Omita esse parâmetro para obter o primeiro lote de revisões.

startDateTime: Date

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

expand: ReportingRevisionsExpand

Retornos

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Substituir o 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 equipe ou nome da equipe

templateId: string

ID do modelo

Retornos

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

Retornos

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

Retornos

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

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

Retornos

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ó a ser criado ou atualizado.

project: string

ID do projeto ou nome do projeto

structureGroup: TreeStructureGroup

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

path: string

Caminho do nó de classificação.

Retornos

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Atualizar um campo.

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

Parâmetros

payload: UpdateWorkItemField

O conteúdo contém o valor desejado das propriedades do campo

fieldNameOrRefName: string

Nome/nome de referência do campo a ser atualizado

project: string

ID do projeto ou nome do projeto

Retornos

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Atualizar 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

A ID ou o caminho da consulta a ser atualizada.

undeleteDescendants: boolean

Desdelete os filhos dessa pasta. É importante observar que isso não trará de volta as alterações de permissão que foram aplicadas anteriormente aos descendentes.

Retornos

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 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 você só deseja validar as alterações sem salvar 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 nenhuma notificação para essa alteração

expand: WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.

Retornos

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

Retornos

Promise<ProvisioningResult>

Compartilhar via

WorkItemTrackingRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

WorkItemTrackingRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

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

Parâmetros

Retornos

createField(WorkItemField, string)

Parâmetros

Retornos

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parâmetros

Retornos

createQuery(QueryHierarchyItem, string, string, boolean)

Parâmetros

Retornos

createTemplate(WorkItemTemplate, string, string)

Parâmetros

Retornos

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

Parâmetros

Retornos

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parâmetros

Retornos

deleteField(string, string)

Parâmetros

Retornos

deleteQuery(string, string)

Parâmetros

Retornos

deleteTemplate(string, string, string)

Parâmetros

Retornos

deleteWorkItem(number, string, boolean)

Parâmetros

Retornos

destroyWorkItem(number, string)

Parâmetros

Retornos

exportWorkItemTypeDefinition(string, string, boolean)

Parâmetros

Retornos

getAccountMyWorkData(QueryOption)

Parâmetros

Retornos

getAttachmentContent(string, string, string, boolean)

Parâmetros

Retornos

getAttachmentZip(string, string, string, boolean)

Parâmetros

Retornos

getClassificationNode(string, TreeStructureGroup, string, number)

Parâmetros

Retornos

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

Parâmetros

Retornos

getComment(number, number, string)

Parâmetros

Retornos

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

Parâmetros

Retornos

getDeletedWorkItem(number, string)

Parâmetros

Retornos

getDeletedWorkItems(number[], string)

Parâmetros

Retornos

getDeletedWorkItemShallowReferences(string)

Parâmetros