WorkItemTrackingRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends: RestClientBase

Costruttori

WorkItemTrackingRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

createAttachment(any, string, string, string, string)	Carica un allegato.
createField(WorkItemField, string)	Creare un nuovo campo.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Creare un nodo di classificazione nuovo o aggiornare un nodo di classificazione esistente.
createQuery(QueryHierarchyItem, string, string, boolean)	Crea una query o sposta una query.
createTemplate(WorkItemTemplate, string, string)	Crea un modello
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Crea un singolo elemento di lavoro.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Eliminare un nodo di classificazione esistente.
deleteField(string, string)	Elimina il campo. Per annullare l'eliminazione di un file, vedere l'API "Update Field".
deleteQuery(string, string)	Eliminare una query o una cartella. In questo modo viene eliminata qualsiasi modifica delle autorizzazioni per la query o la cartella eliminata e i relativi discendenti, se si tratta di una cartella. È importante notare che le modifiche delle autorizzazioni eliminate non possono essere recuperate dopo l'annullamento dell'eliminazione della query o della cartella.
deleteTemplate(string, string, string)	Elimina il modello con id specificato
deleteWorkItem(number, string, boolean)	Elimina l'elemento di lavoro specificato e lo invia al Cestino, in modo che possa essere ripristinato, se necessario. Facoltativamente, se il parametro destroy è stato impostato su true, l'elemento di lavoro viene eliminato definitivamente. AVVISO: se il parametro destroy è impostato su true, gli elementi di lavoro eliminati da questo comando NON verranno recapitati al Cestino e non sarà possibile ripristinarli/ripristinarli dopo l'eliminazione. È consigliabile NON usare questo parametro. In tal caso, usare questo parametro con estrema cautela.
destroyWorkItem(number, string)	Elimina definitivamente l'elemento di lavoro specificato dal Cestino. Questa azione non può essere annullata.
exportWorkItemTypeDefinition(string, string, boolean)	Esportare il tipo di elemento di lavoro
getAccountMyWorkData(QueryOption)	SOLO INTERNO: USATO DALLA PAGINA LAVORO PERSONALE DELL'ACCOUNT. In questo modo vengono restituiti i dettagli degli elementi di lavoro In corso, Done, Follows e Activity.
getAttachmentContent(string, string, string, boolean)	Scarica un allegato.
getAttachmentZip(string, string, string, boolean)	Scarica un allegato.
getClassificationNode(string, TreeStructureGroup, string, number)	Ottiene il nodo di classificazione per un determinato percorso del nodo.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Ottiene i nodi di classificazione radice o l'elenco di nodi di classificazione per un determinato elenco di ID di nodi, per un determinato progetto. Nel caso in cui venga specificato il parametro ids, si otterrà l'elenco dei nodi di classificazione per tali ID. In caso contrario, si otterranno i nodi di classificazione radice per questo progetto.
getComment(number, number, string)	Ottiene un commento per un elemento di lavoro in corrispondenza della revisione specificata.
getComments(number, string, number, number, CommentSortOrder)	Ottiene il numero specificato di commenti per un elemento di lavoro dalla revisione specificata.
getDeletedWorkItem(number, string)	Ottiene un elemento di lavoro eliminato dal Cestino.
getDeletedWorkItems(number[], string)	Ottiene gli elementi di lavoro dal Cestino, i cui ID sono stati specificati nei parametri
getDeletedWorkItemShallowReferences(string)	Ottiene un elenco degli ID e degli URL degli elementi di lavoro eliminati nel Cestino.
getField(string, string)	Ottiene informazioni su un campo specifico.
getFields(string, GetFieldsExpand)	Restituisce informazioni per tutti i campi. Il parametro ID/nome del progetto è facoltativo.
getQueries(string, QueryExpand, number, boolean)	Ottiene le query radice e i relativi figli
getQueriesBatch(QueryBatchGetRequest, string)	Ottiene un elenco di query in base agli ID (massimo 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Recupera una singola query e i relativi elementi figlio
getQueryResultCount(string, string, string, boolean, number)	Ottiene i risultati della query in base all'ID della query.
getRecentActivityData()	Ottiene attività recenti dell'elemento di lavoro
getRecentMentions()	SOLO INTERNO: USATO DALLA PAGINA LAVORO PERSONALE DELL'ACCOUNT.
getRelationType(string)	Ottiene la definizione del tipo di relazione dell'elemento di lavoro.
getRelationTypes()	Ottiene i tipi di relazione dell'elemento di lavoro.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Ottenere un batch di collegamenti all'elemento di lavoro
getRevision(number, number, string, WorkItemExpand)	Restituisce un elemento di lavoro completamente idratato per la revisione richiesta
getRevisions(number, string, number, number, WorkItemExpand)	Restituisce l'elenco delle revisioni dell'elemento di lavoro completamente idratate, paginate.
getRootNodes(string, number)	Ottiene i nodi di classificazione radice nel progetto.
getTemplate(string, string, string)	Ottiene il modello con ID specificato
getTemplates(string, string, string)	Ottiene il modello
getUpdate(number, number, string)	Restituisce un singolo aggiornamento per un elemento di lavoro
getUpdates(number, string, number, number)	Restituisce i differenziali tra le revisioni degli elementi di lavoro
getWorkArtifactLinkTypes()	Ottenere l'elenco dei tipi di collegamento degli elementi di lavoro di rilevamento in uscita.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Restituisce un singolo elemento di lavoro.
getWorkItemIconJson(string, string, number)	Ottenere un'icona dell'elemento di lavoro in base al nome descrittivo e al colore dell'icona.
getWorkItemIcons()	Ottenere un elenco di tutte le icone dell'elemento di lavoro.
getWorkItemIconSvg(string, string, number)	Ottenere un'icona dell'elemento di lavoro in base al nome descrittivo e al colore dell'icona.
getWorkItemIconXaml(string, string, number)	Ottenere un'icona dell'elemento di lavoro in base al nome descrittivo e al colore dell'icona.
getWorkItemNextStatesOnCheckinAction(number[], string)	Restituisce lo stato successivo sugli ID dell'elemento di lavoro specificato.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Restituisce un elenco di elementi di lavoro (massimo 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Ottiene gli elementi di lavoro per un elenco di ID elemento di lavoro (massimo 200)
getWorkItemStateColors(string[])	SOLO INTERNO: verrà usato per l'esperienza aziendale dell'account personale. Ottenere il colore dello stato dell'elemento di lavoro per più progetti
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Restituisce un singolo elemento di lavoro da un modello.
getWorkItemType(string, string)	Restituisce una definizione del tipo di elemento di lavoro.
getWorkItemTypeCategories(string)	Ottiene tutte le categorie di tipi di elemento di lavoro.
getWorkItemTypeCategory(string, string)	Ottiene una categoria specifica del tipo di elemento di lavoro in base al nome.
getWorkItemTypeColorAndIcons(string[])	SOLO INTERNO: viene usato per i provider di colori e icone. Ottenere il colore del tipo di wit per più progetti
getWorkItemTypeColors(string[])	SOLO INTERNO: verrà usato per l'esperienza aziendale dell'account personale. Ottenere il colore del tipo di wit per più progetti
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Ottenere un elenco di campi per un tipo di elemento di lavoro con riferimenti dettagliati.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Ottenere un campo per un tipo di elemento di lavoro con riferimenti dettagliati.
getWorkItemTypes(string)	Restituisce l'elenco dei tipi di elementi di lavoro
getWorkItemTypeStates(string, string)	Restituisce i nomi e i colori dello stato per un tipo di elemento di lavoro.
queryById(string, string, string, boolean, number)	Ottiene i risultati della query in base all'ID della query.
queryByWiql(Wiql, string, string, boolean, number)	Ottiene i risultati della query in base al relativo WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Esegue query sugli elementi di lavoro collegati a un determinato elenco di URI dell'artefatto.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Ottenere un batch di revisioni degli elementi di lavoro con l'opzione di inclusione degli elementi eliminati
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Ottenere un batch di revisioni degli elementi di lavoro. Questa richiesta può essere usata se l'elenco di campi è sufficientemente grande da poter eseguire l'URL oltre il limite di lunghezza.
replaceTemplate(WorkItemTemplate, string, string, string)	Sostituire il contenuto del modello
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Ripristina l'elemento di lavoro eliminato dal Cestino.
searchQueries(string, string, number, QueryExpand, boolean)	Cerca tutte le query a cui l'utente ha accesso nel progetto corrente
sendMail(SendMailBody, string)	Metodo RESTful per inviare messaggi di posta elettronica per gli elementi di lavoro selezionati/sottoposti a query.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Aggiornare un nodo di classificazione esistente.
updateField(UpdateWorkItemField, string, string)	Aggiornare un campo.
updateQuery(QueryHierarchyItem, string, string, boolean)	Aggiornare una query o una cartella. In questo modo è possibile aggiornare, rinominare e spostare query e cartelle.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Aggiornamenti un singolo elemento di lavoro.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Aggiungere/aggiornare un tipo di elemento di lavoro

Dettagli costruttore

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

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

Carica un allegato.

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

Parametri

content: any

Contenuto da caricare

project: string

ID progetto o nome del progetto

fileName: string

Nome del file

uploadType: string

Tipo di caricamento degli allegati: semplice o in blocchi

areaPath: string

Percorso area progetto di destinazione

Restituisce

Promise<AttachmentReference>

createField(WorkItemField, string)

Creare un nuovo campo.

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

Parametri

workItemField: WorkItemField

Nuova definizione di campo

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Creare un nodo di classificazione nuovo o aggiornare un nodo di classificazione esistente.

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

Parametri

postedNode: WorkItemClassificationNode

Nodo da creare o aggiornare.

project: string

ID progetto o nome del progetto

structureGroup: TreeStructureGroup

Gruppo di strutture del nodo di classificazione, dell'area o dell'iterazione.

path: string

Percorso del nodo di classificazione.

Restituisce

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Crea una query o sposta una query.

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

Parametri

postedQuery: QueryHierarchyItem

Query da creare.

project: string

ID progetto o nome del progetto

query: string

ID padre o percorso in cui deve essere creata la query.

validateWiqlOnly: boolean

Se si vuole solo convalidare la query WIQL senza crearne una, impostarla su true. L'impostazione predefinita è false.

Restituisce

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Crea un modello

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

Parametri

template: WorkItemTemplate

Contenuto del modello

project: string

ID progetto o nome del progetto

team: string

ID team o nome del team

Restituisce

Promise<WorkItemTemplate>

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

Crea un singolo elemento di lavoro.

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

Parametri

document: JsonPatchDocument

Documento json Patch che rappresenta l'elemento di lavoro

project: string

ID progetto o nome del progetto

type: string

Tipo di elemento di lavoro dell'elemento di lavoro da creare

validateOnly: boolean

Indicare se si desidera solo convalidare le modifiche senza salvare l'elemento di lavoro

bypassRules: boolean

Non applicare le regole del tipo di elemento di lavoro per questo aggiornamento

suppressNotifications: boolean

Non generare notifiche per questa modifica

expand: WorkItemExpand

Parametri di espansione per gli attributi degli elementi di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }.

Restituisce

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Eliminare un nodo di classificazione esistente.

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

Parametri

project: string

ID progetto o nome del progetto

structureGroup: TreeStructureGroup

Gruppo di strutture del nodo di classificazione, dell'area o dell'iterazione.

path: string

Percorso del nodo di classificazione.

reclassifyId: number

ID del nodo di classificazione di destinazione per la riclassificazione.

Restituisce

Promise<void>

deleteField(string, string)

Elimina il campo. Per annullare l'eliminazione di un file, vedere l'API "Update Field".

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

Parametri

fieldNameOrRefName: string

Nome semplice del campo o nome di riferimento

project: string

ID progetto o nome del progetto

Restituisce

Promise<void>

deleteQuery(string, string)

Eliminare una query o una cartella. In questo modo viene eliminata qualsiasi modifica delle autorizzazioni per la query o la cartella eliminata e i relativi discendenti, se si tratta di una cartella. È importante notare che le modifiche delle autorizzazioni eliminate non possono essere recuperate dopo l'annullamento dell'eliminazione della query o della cartella.

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

Parametri

project: string

ID progetto o nome del progetto

query: string

ID o percorso della query o della cartella da eliminare.

Restituisce

Promise<void>

deleteTemplate(string, string, string)

Elimina il modello con id specificato

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

Parametri

project: string

ID progetto o nome del progetto

team: string

ID team o nome del team

templateId: string

ID modello

Restituisce

Promise<void>

deleteWorkItem(number, string, boolean)

Elimina l'elemento di lavoro specificato e lo invia al Cestino, in modo che possa essere ripristinato, se necessario. Facoltativamente, se il parametro destroy è stato impostato su true, l'elemento di lavoro viene eliminato definitivamente. AVVISO: se il parametro destroy è impostato su true, gli elementi di lavoro eliminati da questo comando NON verranno recapitati al Cestino e non sarà possibile ripristinarli/ripristinarli dopo l'eliminazione. È consigliabile NON usare questo parametro. In tal caso, usare questo parametro con estrema cautela.

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

Parametri

id: number

ID dell'elemento di lavoro da eliminare

project: string

ID progetto o nome del progetto

destroy: boolean

Parametro facoltativo, se impostato su true, l'elemento di lavoro viene eliminato definitivamente. Nota: l'azione di eliminazione definitiva è PERMANENTE e non può essere annullata.

Restituisce

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Elimina definitivamente l'elemento di lavoro specificato dal Cestino. Questa azione non può essere annullata.

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

Parametri

id: number

ID dell'elemento di lavoro da eliminare definitivamente

project: string

ID progetto o nome del progetto

Restituisce

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Esportare il tipo di elemento di lavoro

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

Parametri

project: string

ID progetto o nome del progetto

type: string

exportGlobalLists: boolean

Restituisce

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

SOLO INTERNO: USATO DALLA PAGINA LAVORO PERSONALE DELL'ACCOUNT. In questo modo vengono restituiti i dettagli degli elementi di lavoro In corso, Done, Follows e Activity.

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

Parametri

queryOption: QueryOption

Restituisce

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Scarica un allegato.

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

Parametri

id: string

ID allegato

project: string

ID progetto o nome del progetto

fileName: string

Nome del file

download: boolean

Se impostato su <c>true</c> scarica sempre allegato

Restituisce

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Scarica un allegato.

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

Parametri

id: string

ID allegato

project: string

ID progetto o nome del progetto

fileName: string

Nome del file

download: boolean

Se impostato su <c>true</c> scarica sempre allegato

Restituisce

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Ottiene il nodo di classificazione per un determinato percorso del nodo.

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

Parametri

project: string

ID progetto o nome del progetto

structureGroup: TreeStructureGroup

Gruppo di strutture del nodo di classificazione, dell'area o dell'iterazione.

path: string

Percorso del nodo di classificazione.

depth: number

Profondità dei bambini da recuperare.

Restituisce

Promise<WorkItemClassificationNode>

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

Ottiene i nodi di classificazione radice o l'elenco di nodi di classificazione per un determinato elenco di ID di nodi, per un determinato progetto. Nel caso in cui venga specificato il parametro ids, si otterrà l'elenco dei nodi di classificazione per tali ID. In caso contrario, si otterranno i nodi di classificazione radice per questo progetto.

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

Parametri

project: string

ID progetto o nome del progetto

ids: number[]

ID di nodi di classificazione integer delimitati da virgole. Non è necessario, se si desiderano nodi radice.

depth: number

Profondità dei bambini da recuperare.

errorPolicy: ClassificationNodesErrorPolicy

Flag per gestire gli errori nel recupero di alcuni nodi. Le opzioni possibili sono Fail e Omit.

Restituisce

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Ottiene un commento per un elemento di lavoro in corrispondenza della revisione specificata.

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

Parametri

id: number

ID elemento di lavoro

revision: number

Revisione per cui è necessario recuperare il commento

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemComment>

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

Ottiene il numero specificato di commenti per un elemento di lavoro dalla revisione specificata.

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

Parametri

id: number

ID elemento di lavoro

project: string

ID progetto o nome del progetto

fromRevision: number

Revisione da cui recuperare i commenti (il valore predefinito è 1)

top: number

Numero di commenti da restituire (il valore predefinito è 200)

order: CommentSortOrder

Crescente o decrescente in base all'ID revisione (il valore predefinito è crescente)

Restituisce

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Ottiene un elemento di lavoro eliminato dal Cestino.

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

Parametri

id: number

ID dell'elemento di lavoro da restituire

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Ottiene gli elementi di lavoro dal Cestino, i cui ID sono stati specificati nei parametri

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

Parametri

ids: number[]

Elenco delimitato da virgole di ID degli elementi di lavoro eliminati da restituire

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Ottiene un elenco degli ID e degli URL degli elementi di lavoro eliminati nel Cestino.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Ottiene informazioni su un campo specifico.

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

Parametri

fieldNameOrRefName: string

Nome semplice del campo o nome di riferimento

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Restituisce informazioni per tutti i campi. Il parametro ID/nome del progetto è facoltativo.

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

Parametri

project: string

ID progetto o nome progetto

expand: GetFieldsExpand

Usare ExtensionFields per includere campi di estensione, in caso contrario escluderli. A meno che il flag di funzionalità per questo parametro sia abilitato, i campi di estensione sono sempre inclusi.

Restituisce

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Ottiene le query radice e i relativi figli

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

Parametri

project: string

ID progetto o nome progetto

expand: QueryExpand

Includere la stringa di query (wiql), le clausole, le colonne dei risultati delle query e le opzioni di ordinamento nei risultati.

depth: number

Nella cartella delle query restituire query figlio e cartelle a questa profondità.

includeDeleted: boolean

Includere query e cartelle eliminate

Restituisce

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Ottiene un elenco di query in base agli ID (massimo 1000)

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

Parametri

queryGetRequest: QueryBatchGetRequest

project: string

ID progetto o nome progetto

Restituisce

Promise<QueryHierarchyItem[]>

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

Recupera una singola query e i relativi elementi figlio

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

Parametri

project: string

ID progetto o nome progetto

query: string

ID o percorso della query.

expand: QueryExpand

Includere la stringa di query (wiql), le clausole, le colonne dei risultati delle query e le opzioni di ordinamento nei risultati.

depth: number

Nella cartella delle query restituire query figlio e cartelle a questa profondità.

includeDeleted: boolean

Includere query e cartelle eliminate

useIsoDateFormat: boolean

Le clausole di query DateTime verranno formattate usando un formato conforme a ISO 8601

Restituisce

Promise<QueryHierarchyItem>

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

Ottiene i risultati della query in base all'ID della query.

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

Parametri

id: string

ID query.

project: string

ID progetto o nome progetto

team: string

ID team o nome team

timePrecision: boolean

Indica se usare o meno la precisione del tempo.

top: number

Numero massimo di risultati da restituire.

Restituisce

Promise<number>

getRecentActivityData()

Ottiene attività recenti dell'elemento di lavoro

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Restituisce

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

SOLO INTERNO: USATO DALLA PAGINA LAVORO PERSONALE DELL'ACCOUNT.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Restituisce

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Ottiene la definizione del tipo di relazione dell'elemento di lavoro.

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

Parametri

relation: string

Nome della relazione

Restituisce

Promise<WorkItemRelationType>

getRelationTypes()

Ottiene i tipi di relazione dell'elemento di lavoro.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Restituisce

Promise<WorkItemRelationType[]>

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

Ottenere un batch di collegamenti all'elemento di lavoro

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

Parametri

project: string

ID progetto o nome progetto

linkTypes: string[]

Elenco di tipi per filtrare i risultati in tipi di collegamento specifici. Omettere questo parametro per ottenere collegamenti all'elemento di lavoro di tutti i tipi di collegamento.

types: string[]

Elenco di tipi per filtrare i risultati in tipi di elemento di lavoro specifici. Omettere questo parametro per ottenere collegamenti all'elemento di lavoro di tutti i tipi di elemento di lavoro.

continuationToken: string

Specifica la continuazioneToken da cui avviare il batch. Omettere questo parametro per ottenere il primo batch di collegamenti.

startDateTime: Date

Data/ora da usare come punto di partenza per le modifiche al collegamento. Verranno restituite solo le modifiche del collegamento che si sono verificate dopo tale data/ora. Impossibile usare insieme al parametro 'filigrana'.

Restituisce

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Restituisce un elemento di lavoro completamente idratato per la revisione richiesta

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

Parametri

id: number

revisionNumber: number

project: string

ID progetto o nome progetto

expand: WorkItemExpand

Restituisce

Promise<WorkItem>

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

Restituisce l'elenco delle revisioni dell'elemento di lavoro completamente idratate, paginate.

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

Parametri

id: number

project: string

ID progetto o nome progetto

top: number

skip: number

expand: WorkItemExpand

Restituisce

Promise<WorkItem[]>

getRootNodes(string, number)

Ottiene i nodi di classificazione radice nel progetto.

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

Parametri

project: string

ID progetto o nome progetto

depth: number

Profondità dei bambini da recuperare.

Restituisce

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Ottiene il modello con ID specificato

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

Parametri

project: string

ID progetto o nome progetto

team: string

ID team o nome team

templateId: string

ID modello

Restituisce

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Ottiene il modello

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

Parametri

project: string

ID progetto o nome progetto

team: string

ID team o nome team

workitemtypename: string

Facoltativo, se specificato restituisce modelli per il tipo di elemento di lavoro specificato.

Restituisce

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Restituisce un singolo aggiornamento per un elemento di lavoro

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

Parametri

id: number

updateNumber: number

project: string

ID progetto o nome progetto

Restituisce

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Restituisce i differenziali tra le revisioni degli elementi di lavoro

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

Parametri

id: number

project: string

ID progetto o nome progetto

top: number

skip: number

Restituisce

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Ottenere l'elenco dei tipi di collegamento degli elementi di lavoro di rilevamento in uscita.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Restituisce

Promise<WorkArtifactLink[]>

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

Restituisce un singolo elemento di lavoro.

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

Parametri

id: number

ID elemento di lavoro

project: string

ID progetto o nome progetto

fields: string[]

Elenco delimitato da virgole di campi richiesti

asOf: Date

Stringa di ora della data UTC AsOf

expand: WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }.

Restituisce

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Ottenere un'icona dell'elemento di lavoro in base al nome descrittivo e al colore dell'icona.

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

Parametri

icon: string

Nome dell'icona

color: string

Colore esadecimale a 6 cifre per l'icona

v: number

Versione dell'icona (utilizzata solo per l'invalidazione della cache)

Restituisce

Promise<WorkItemIcon>

getWorkItemIcons()

Ottenere un elenco di tutte le icone dell'elemento di lavoro.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Restituisce

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Ottenere un'icona dell'elemento di lavoro in base al nome descrittivo e al colore dell'icona.

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

Parametri

icon: string

Nome dell'icona

color: string

Colore esadecimale a 6 cifre per l'icona

v: number

Versione dell'icona (utilizzata solo per l'invalidazione della cache)

Restituisce

Promise<any>

getWorkItemIconXaml(string, string, number)

Ottenere un'icona dell'elemento di lavoro in base al nome descrittivo e al colore dell'icona.

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

Parametri

icon: string

Nome dell'icona

color: string

Colore esadecimale a 6 cifre per l'icona

v: number

Versione dell'icona (utilizzata solo per l'invalidazione della cache)

Restituisce

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Restituisce lo stato successivo sugli ID dell'elemento di lavoro specificato.

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

Parametri

ids: number[]

elenco degli ID elemento di lavoro

action: string

possibili azioni. Attualmente supporta solo il checkin

Restituisce

Promise<WorkItemNextStateOnTransition[]>

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

Restituisce un elenco di elementi di lavoro (massimo 200)

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

Parametri

ids: number[]

Elenco delimitato da virgole degli ID elemento di lavoro richiesti. (Massimo 200 ID consentiti).

project: string

ID progetto o nome progetto

fields: string[]

Elenco delimitato da virgole di campi richiesti

asOf: Date

Stringa di ora della data UTC AsOf

expand: WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }.

errorPolicy: WorkItemErrorPolicy

Flag per controllare i criteri di errore in una richiesta di elementi di lavoro in blocco. Le opzioni possibili sono {Fail, Omit}.

Restituisce

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Ottiene gli elementi di lavoro per un elenco di ID elemento di lavoro (massimo 200)

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

Parametri

workItemGetRequest: WorkItemBatchGetRequest

project: string

ID progetto o nome progetto

Restituisce

Promise<WorkItem[]>

getWorkItemStateColors(string[])

SOLO INTERNO: verrà usato per l'esperienza aziendale dell'account personale. Ottenere il colore dello stato dell'elemento di lavoro per più progetti

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

Parametri

projectNames: string[]

Restituisce

Promise<ProjectWorkItemStateColors[]>

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

Restituisce un singolo elemento di lavoro da un modello.

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

Parametri

project: string

ID progetto o nome progetto

type: string

Nome del tipo di elemento di lavoro

fields: string

Elenco delimitato da virgole di campi richiesti

asOf: Date

Stringa di data e ora UTC AsOf

expand: WorkItemExpand

Parametri di espansione per gli attributi degli elementi di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }.

Restituisce

Promise<WorkItem>

getWorkItemType(string, string)

Restituisce una definizione del tipo di elemento di lavoro.

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

Parametri

project: string

ID progetto o nome del progetto

type: string

Nome del tipo di elemento di lavoro

Restituisce

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Ottiene tutte le categorie di tipi di elemento di lavoro.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Ottiene una categoria specifica del tipo di elemento di lavoro in base al nome.

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

Parametri

project: string

ID progetto o nome del progetto

category: string

Nome della categoria

Restituisce

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

SOLO INTERNO: viene usato per i provider di colori e icone. Ottenere il colore del tipo di wit per più progetti

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

Parametri

projectNames: string[]

Restituisce

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

getWorkItemTypeColors(string[])

SOLO INTERNO: verrà usato per l'esperienza aziendale dell'account personale. Ottenere il colore del tipo di wit per più progetti

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

Parametri

projectNames: string[]

Restituisce

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Ottenere un elenco di campi per un tipo di elemento di lavoro con riferimenti dettagliati.

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

Parametri

project: string

ID progetto o nome del progetto

type: string

Tipo di elemento di lavoro.

expand: WorkItemTypeFieldsExpandLevel

Espandere il livello per la risposta dell'API. Proprietà: per includere allowedvalues, valore predefinito, isRequired e così via come parte della risposta; Nessuno: per ignorare queste proprietà.

Restituisce

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Ottenere un campo per un tipo di elemento di lavoro con riferimenti dettagliati.

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

Parametri

project: string

ID progetto o nome del progetto

type: string

Tipo di elemento di lavoro.

field: string

expand: WorkItemTypeFieldsExpandLevel

Espandere il livello per la risposta dell'API. Proprietà: per includere allowedvalues, valore predefinito, isRequired e così via come parte della risposta; Nessuno: per ignorare queste proprietà.

Restituisce

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Restituisce l'elenco dei tipi di elementi di lavoro

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Restituisce i nomi e i colori dello stato per un tipo di elemento di lavoro.

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

Parametri

project: string

ID progetto o nome del progetto

type: string

Nome dello stato

Restituisce

Promise<WorkItemStateColor[]>

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

Ottiene i risultati della query in base all'ID della query.

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

Parametri

id: string

ID query.

project: string

ID progetto o nome del progetto

team: string

ID team o nome del team

timePrecision: boolean

Indica se usare o meno la precisione temporale.

top: number

Numero massimo di risultati da restituire.

Restituisce

Promise<WorkItemQueryResult>

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

Ottiene i risultati della query in base al relativo WIQL.

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

Parametri

wiql: Wiql

Query contenente WIQL.

project: string

ID progetto o nome del progetto

team: string

ID team o nome del team

timePrecision: boolean

Indica se usare o meno la precisione temporale.

top: number

Numero massimo di risultati da restituire.

Restituisce

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Esegue query sugli elementi di lavoro collegati a un determinato elenco di URI dell'artefatto.

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

Parametri

artifactUriQuery: ArtifactUriQuery

Definisce un elenco di URI di artefatti per l'esecuzione di query sugli elementi di lavoro.

project: string

ID progetto o nome del progetto

Restituisce

Promise<ArtifactUriQueryResult>

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

Ottenere un batch di revisioni degli elementi di lavoro con l'opzione di inclusione degli elementi eliminati

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>

Parametri

project: string

ID progetto o nome del progetto

fields: string[]

Elenco di campi da restituire nelle revisioni degli elementi di lavoro. Omettere questo parametro per ottenere tutti i campi segnalabili.

types: string[]

Elenco di tipi per filtrare i risultati in base a tipi di elementi di lavoro specifici. Omettere questo parametro per ottenere revisioni degli elementi di lavoro di tutti i tipi di elemento di lavoro.

continuationToken: string

Specifica la filigrana da cui avviare il batch. Omettere questo parametro per ottenere il primo batch di revisioni.

startDateTime: Date

Data/ora da usare come punto di partenza per le revisioni, tutte le revisioni verranno eseguite dopo questa data/ora. Non può essere usato insieme al parametro 'watermark'.

includeIdentityRef: boolean

Restituisce un riferimento di identità anziché un valore stringa per i campi Identity.

includeDeleted: boolean

Specificare se l'elemento eliminato deve essere restituito.

includeTagRef: boolean

Specificare se gli oggetti tag devono essere restituiti per il campo System.Tags.

includeLatestOnly: boolean

Restituisce solo le revisioni più recenti degli elementi di lavoro, ignorando tutte le revisioni cronologiche

expand: ReportingRevisionsExpand

Restituisce tutti i campi nelle revisioni degli elementi di lavoro, inclusi i campi di testo lunghi che non vengono restituiti per impostazione predefinita

includeDiscussionChangesOnly: boolean

Restituisce solo le revisioni degli elementi di lavoro, in cui è stato modificato solo il campo della cronologia

maxPageSize: number

Numero massimo di risultati da restituire in questo batch

Restituisce

Promise<ReportingWorkItemRevisionsBatch>

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

Ottenere un batch di revisioni degli elementi di lavoro. Questa richiesta può essere usata se l'elenco di campi è sufficientemente grande da poter eseguire l'URL oltre il limite di lunghezza.

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

Parametri

filter: ReportingWorkItemRevisionsFilter

Oggetto che contiene le impostazioni della richiesta: filtro del campo, filtro del tipo, formato di identità

project: string

ID progetto o nome del progetto

continuationToken: string

Specifica la filigrana da cui avviare il batch. Omettere questo parametro per ottenere il primo batch di revisioni.

startDateTime: Date

Data/ora da usare come punto di partenza per le revisioni, tutte le revisioni verranno eseguite dopo questa data/ora. Non può essere usato insieme al parametro 'watermark'.

expand: ReportingRevisionsExpand

Restituisce

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Sostituire il contenuto del modello

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

Parametri

templateContent: WorkItemTemplate

Contenuto del modello da sostituire con

project: string

ID progetto o nome del progetto

team: string

ID team o nome del team

templateId: string

ID modello

Restituisce

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Ripristina l'elemento di lavoro eliminato dal Cestino.

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

Parametri

payload: WorkItemDeleteUpdate

Pagamento con le istruzioni per aggiornare il flag IsDeleted su false

id: number

ID dell'elemento di lavoro da ripristinare

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemDelete>

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

Cerca tutte le query a cui l'utente ha accesso nel progetto corrente

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

Parametri

project: string

ID progetto o nome del progetto

filter: string

Testo con cui filtrare le query.

top: number

Numero di query da restituire (il valore predefinito è 50 e massimo è 200).

expand: QueryExpand

includeDeleted: boolean

Includere query e cartelle eliminate

Restituisce

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Metodo RESTful per inviare messaggi di posta elettronica per gli elementi di lavoro selezionati/sottoposti a query.

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

Parametri

body: SendMailBody

project: string

ID progetto o nome del progetto

Restituisce

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Aggiornare un nodo di classificazione esistente.

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

Parametri

postedNode: WorkItemClassificationNode

Nodo da creare o aggiornare.

project: string

ID progetto o nome del progetto

structureGroup: TreeStructureGroup

Gruppo di strutture del nodo di classificazione, dell'area o dell'iterazione.

path: string

Percorso del nodo di classificazione.

Restituisce

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Aggiornare un campo.

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

Parametri

payload: UpdateWorkItemField

Il payload contiene il valore desiderato delle proprietà del campo

fieldNameOrRefName: string

Nome/nome del campo da aggiornare

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Aggiornare una query o una cartella. In questo modo è possibile aggiornare, rinominare e spostare query e cartelle.

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

Parametri

queryUpdate: QueryHierarchyItem

Query da aggiornare.

project: string

ID progetto o nome progetto

query: string

ID o percorso della query da aggiornare.

undeleteDescendants: boolean

Annullare l'eliminazione degli elementi figlio di questa cartella. È importante notare che questa operazione non restituirà le modifiche delle autorizzazioni applicate in precedenza ai discendenti.

Restituisce

Promise<QueryHierarchyItem>

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

Aggiornamenti un singolo elemento di lavoro.

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

Parametri

document: JsonPatchDocument

Documento patch JSON che rappresenta l'aggiornamento

id: number

ID dell'elemento di lavoro da aggiornare

project: string

ID progetto o nome progetto

validateOnly: boolean

Indicare se si desidera convalidare solo le modifiche senza salvare l'elemento di lavoro

bypassRules: boolean

Non applicare le regole del tipo di elemento di lavoro in questo aggiornamento

suppressNotifications: boolean

Non generare notifiche per questa modifica

expand: WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }.

Restituisce

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Aggiungere/aggiornare un tipo di elemento di lavoro

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

Parametri

updateModel: WorkItemTypeTemplateUpdateModel

project: string

ID progetto o nome progetto

Restituisce

Promise<ProvisioningResult>

Condividi tramite

WorkItemTrackingRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

WorkItemTrackingRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

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

Parametri

Restituisce

createField(WorkItemField, string)

Parametri

Restituisce

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parametri

Restituisce

createQuery(QueryHierarchyItem, string, string, boolean)

Parametri

Restituisce

createTemplate(WorkItemTemplate, string, string)

Parametri

Restituisce

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

Parametri

Restituisce

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parametri

Restituisce

deleteField(string, string)

Parametri

Restituisce

deleteQuery(string, string)

Parametri

Restituisce

deleteTemplate(string, string, string)

Parametri

Restituisce

deleteWorkItem(number, string, boolean)

Parametri

Restituisce

destroyWorkItem(number, string)

Parametri

Restituisce

exportWorkItemTypeDefinition(string, string, boolean)

Parametri

Restituisce

getAccountMyWorkData(QueryOption)

Parametri

Restituisce

getAttachmentContent(string, string, string, boolean)

Parametri

Restituisce

getAttachmentZip(string, string, string, boolean)

Parametri

Restituisce

getClassificationNode(string, TreeStructureGroup, string, number)

Parametri

Restituisce

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

Parametri

Restituisce

getComment(number, number, string)

Parametri

Restituisce

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

Parametri

Restituisce

getDeletedWorkItem(number, string)

Parametri

Restituisce

getDeletedWorkItems(number[], string)

Parametri

Restituisce

getDeletedWorkItemShallowReferences(string)

Parametri