TestResultsRestClient class

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Costruttori

TestResultsRestClient(IVssRestClientOptions)

Proprietà

Metodi

addCustomFields(CustomTestFieldDefinition[], string)	Crea campi di test personalizzati in base ai dati forniti.
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	Aggiungere i risultati dei test alla sessione di esecuzione dei test
addWorkItemToTestLinks(WorkItemToTestLinks, string)
callbackTestAgent(TestAgentCallbackRequest, string)
completeGitHubAuth(string, string)	Endpoint di callback OAuth. GitHub reindirizza qui dopo l'autorizzazione dell'utente. Scambia il codice di autorizzazione per i token e li archivia in StrongBox TCM. Richiede la registrazione dell'URL di callback nelle impostazioni dell'app OAuth GitHub.
createAnalysis(TestSessionAnalysis[], string, number)	Crea un oggetto Analisi sessione nell'archivio dati TCM per una determinata sessione
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	Crea un allegato nell'archivio log per il valore buildId specificato.
createEnvironment(TestSessionEnvironment[], string)	Crea un oggetto Environment nell'archivio dati TCM
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	Per sessionId specificato, crea oggetti ambiente, configurazione e computer nell'archivio dati TCM
createFailureType(TestResultFailureTypeRequestModel, string)	Crea un nuovo tipo di errore di test
createNotification(TestSessionNotification[], string, number)	Crea un oggetto Notification nell'archivio dati TCM per una determinata sessione
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)	Registra i metadati per un allegato di test a livello di risultato il cui contenuto è già stato caricato nella memoria dedup dal chiamante. La richiesta contiene solo i metadati dell'allegato (id deduplicato, dimensione, nome file, tipo, ecc.) e nessun byte del file.
createTestResultMachines(TestResultMachine[], string, number)	Crea i computer dei risultati del test per l'oggetto TestRunId specificato
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)	Registra i metadati di un allegato di test a livello di esecuzione il cui contenuto è già stato caricato nella memoria dedup dal chiamante. La richiesta contiene solo i metadati dell'allegato (id deduplicato, dimensione, nome file, tipo, ecc.) e nessun byte del file.
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	Crea un allegato nell'archivio log per l'id runid specificato.
createTestSession(TestResultsSession, string)	Crea un oggetto TestResultsSession nell'archivio dati TCM
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)	Registra i metadati di un allegato di test a livello di risultato il cui contenuto è già stato caricato nella memoria dedup dal chiamante. La richiesta contiene solo i metadati dell'allegato (id deduplicato, dimensione, nome file, tipo, ecc.) e nessun byte del file.
deleteCustomFieldById(string, number)	Restituisce i dettagli del campo di test personalizzato per il testExtensionFieldId specificato.
deleteFailureType(string, number)	Elimina un tipo di errore di test con failureTypeId specificato
deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)	Elimina gli ID di riferimento del caso di test inaffidabili tramite informazioni di branch e repository
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)	Elimina l'allegato con il nome file specificato per il valore runId specificato dall'archivio log.
deleteTestSettings(string, number)
enhanceCoverage(string, string, number)	Punto d'ingresso cliccabile dal browser per il link "Potenzia la copertura diff" visualizzato nei commenti della copertura PR. Invia un compito coverage_test_generation ad ADOAgenticService per la pull request data e reindirizza l'utente alla pagina pull request.
fetchSourceCodeCoverageReport(string, number)
generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)	Genera un piano di test manuale da un elemento di lavoro usando l'IA. Se l'utente non ha un token Copilot valido, restituisce needsAuth=true con un authUrl invece di mettere in coda il lavoro.
getAfdTcmEndpoint(string)
getBranchesByFlakyTestCaseRefId(string, number)	Ottenere l'elenco dei rami in cui l'ID di riferimento di un test case si è sfaldato
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)
getCodeCoverageSummary(string, number, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Richiesta: ID di compilazione e ID di compilazione differenziale (facoltativo)
getCoverageStatusBadge(string, string, string, string)	<p>Ottiene lo stato di copertura per l'ultima compilazione riuscita di una definizione, con ambito facoltativo per un ramo</p specifico>
getFailureTypes(string)	Restituisce l'elenco dei tipi di errore di test.
getFileLevelCodeCoverage(FileCoverageRequest, string)	Ottenere la copertura dei file per il file specificato
getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)	Ricevi l'ultimo risultato per ogni TestCaseID richiesto. I casi di test mai eseguiti (nessun risultato in un'esecuzione non cancellata) vengono omessiti dalla risposta: il chiamante considera la loro assenza come "mai eseguito".
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	Recupera gli oggetti TestResultsSession Notification nell'archivio dati TCM
getSimilarTestResults(string, number, number, number, number, String)	Ottiene l'elenco dei risultati il cui errore corrisponde a quello fornito.
getTestAgentToken()	Restituisce il token GitHub OAuth dell'utente attuale con il permesso di accedere alle API per Copilot, con un badge di funzionalità bloccato.
getTestIterationAttachmentContent(string, number, number, number, number)	Restituisce un allegato di iterazione di test
getTestIterationAttachmentZip(string, number, number, number, number)	Restituisce un allegato di iterazione di test
getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)	Ottenere un elenco di riferimenti per gli allegati di compilazione
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	Ottenere l'URI di firma di accesso condiviso di un allegato di compilazione
getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)	Ottenere l'URI di firma di accesso condiviso di un allegato dei risultati del test
getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)	Ottenere l'URI di firma di accesso condiviso di un allegato di esecuzione del test
getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)	Ottenere l'URI di firma di accesso condiviso di un allegato secondario di test
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	Ottenere un riepilogo dei risultati dei test.
getTestResultAttachmentContent(string, number, number, number)	Restituisce un allegato dei risultati del test
getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)	Restituisce un allegato dei risultati del test
getTestResultById(string, number, number, ResultDetails)
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)	Ottenere un riepilogo dei risultati dei test per una compilazione. Per recuperare l'intero TestCaseResult, chiamare Results - Get.
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)	Ottenere un elenco di riferimenti ai risultati del test
getTestResultMachines(string, number)	Ottiene i computer dei risultati del test per l'oggetto TestRunId specificato
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)	Ottenere un elenco di risultati.
getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)	Ottiene gli oggetti TestCaseResult completi con dettagli 1MRX per il valore pipelineId specificato
getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)	Ottenere dati TestResultsSettings
getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)	Restituisce un allegato di esecuzione del test
getTestRunAttachments(string, number)
getTestRunAttachmentUploadDetails(string, number)	Pre-flight per un caricamento allegato diretto a BlobStore: applica il permesso di pubblicazione e restituisce il dominio dedup a cui pubblicare. L'agente chiama questo prima di caricare qualsiasi byte.
getTestRunAttachmentZip(string, number, number)	Restituisce un allegato di esecuzione del test
getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)	Ottenere l'elenco dei riferimenti agli allegati di esecuzione dei test
getTestRunLogStoreAttachmentContent(string, number, string)	Restituisce l'allegato con il nome file specificato per il valore runId specificato da LogStore.
getTestRunLogStoreAttachments(string, number)	Restituisce un elenco di allegati per l'id runId specificato dall'archivio log.
getTestRunLogStoreAttachmentZip(string, number, string)	Restituisce l'allegato con il nome file specificato per il valore runId specificato da LogStore.
getTestRunMessageLogs(string, number)	Ottenere i log dei messaggi di esecuzione del test
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
getTestRunsBySessionId(string, number)	Recupera le esecuzioni di test associate a una sessione
getTestRunStatistics(string, number)	Ottenere le statistiche di esecuzione dei test , usate quando si vuole ottenere un riepilogo di un'esecuzione in base al risultato.
getTestRunSummaryByOutcome(string, number)	Ottenere il riepilogo dell'esecuzione dei test, usato quando si vuole ottenere un riepilogo di un'esecuzione in base al risultato. L'esecuzione dei test deve essere completata.
getTestSession(string, number)	Recupera l'oggetto metadati TestResultsSession nell'archivio dati TCM
getTestSessionLayout(string, string)	Recupera l'oggetto Layout TestResultsSession nell'archivio dati TCM
getTestSessionLayoutBySessionId(string, number)	Recupera l'oggetto Layout TestResultsSession nell'archivio dati TCM
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Restituisce un allegato di risultati secondari del test
getTestSubResultAttachments(string, number, number, number)	Restituisce i riferimenti agli allegati per il risultato secondario del test.
getTestSubResultAttachmentZip(string, number, number, number, number)	Restituisce un allegato di risultati secondari del test
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	Ottenere l'elenco di riferimenti ai sottoresult di test
getTestTagsForBuild(string, number)	Ottenere tutti i tag in una compilazione.
getTestTagsForRelease(string, number, number)	Ottenere tutti i tag in una versione.
getTestTagSummaryForBuild(string, number)	Ottenere tutti i tag in una compilazione.
getTestTagSummaryForRelease(string, number, number)	Ottenere tutti i tag in una versione.
getTestWeightedScoreByTestRun(string, string, boolean, boolean)	Calcolare il punteggio ponderato del test per una data lista separata di ID delle corse di test.
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)	Restituisce l'elenco dei campi di test personalizzati per l'ambito del campo di test personalizzato specificato.
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Ottenere la cronologia di un metodo di test usando TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)	Restituisce metadati per gli allegati di test supportati da BlobStore a livello di risultato il cui nome file inizia con fileNamePrefix, o per il singolo allegato identificato da attachmentId quando viene fornito.
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)	Ottenere l'elenco dei metadati dei risultati del test per il testcasereferenceId corrispondente
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)	Ottenere un riepilogo dei risultati dei test.
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	Query Test Result WorkItems basato sul filtro
queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)	Restituisce metadati per gli allegati di test supportati da BlobStore a livello di run il cui nome file inizia con fileNamePrefix, o per il singolo allegato identificato da attachmentId quando viene fornito. L'agente utilizza questo per enumerare i log di test BlobStore (dedup), che non sono presenti nel contenitore SAS classico di LogStore e quindi non possono essere elencati direttamente dall'agente.
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)	Esecuzione di test di query in base ai filtri. I campi obbligatori sono minLastUpdatedDate e maxLastUpdatedDate.
queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)	Restituisce metadati per gli allegati di test supportati da BlobStore a livello di risultato inferiore il cui nome file inizia con fileNamePrefix, o per il singolo allegato identificato da attachmentId quando viene fornito.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	Creare e ottenere l'URI sas del contenitore di compilazione
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	Creare un file vuoto per un risultato e ottenere l'URI di firma di accesso condiviso per il file
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	Creare un file vuoto per un'esecuzione e ottenere l'URI di firma di accesso condiviso per il file
testResultsGroupDetails(string, number, string, string, string, boolean, boolean)	Ottenere tutti i dettagli dei gruppi disponibili e per questi gruppi vengono restituiti risultati non riusciti e interrotti.
triggerTestAgent(TestAgentTriggerRequest, string)
updateCodeCoverageSummary(string, number, CodeCoverageData)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Richiesta: Json del riepilogo della copertura del codice
updateCustomField(CustomTestFieldUpdateDefinition, string)	Restituisce i dettagli del campo di test personalizzato che viene aggiornato.
updatePipelinesTestSettings(TestResultsUpdateSettings, string)	Aggiornare le impostazioni del progetto dei risultati dei test
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	Aggiornare le proprietà dei metadati dei risultati del test
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	Crea oggetti TestResultsMRX nell'archivio dati TCM per i risultati dei test esistenti
updateTestRun(RunUpdateModel, string, number)
updateTestRunsBySessionId(TestSessionTestRun, string, number)	Aggiorna le esecuzioni di test associate a una sessione
updateTestRunTags(TestTagsUpdateModel, string, number)	Aggiornare i tag di un'esecuzione, i tag possono essere aggiunti ed eliminati
updateTestSession(TestResultsSession, string, number)	Aggiorna l'oggetto sessione di test associato a un sessionId

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "c83eaf52-edf3-4034-ae11-17d38f25404c" = "c83eaf52-edf3-4034-ae11-17d38f25404c"

Valore della proprietà

"c83eaf52-edf3-4034-ae11-17d38f25404c"

addCustomFields(CustomTestFieldDefinition[], string)

Crea campi di test personalizzati in base ai dati forniti.

function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>

Parametri

newFields: CustomTestFieldDefinition[]

NewFields è una matrice di tipo CustomTestFieldDefinition.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametri

results: TestCaseResult[]

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Aggiungere i risultati dei test alla sessione di esecuzione dei test

function addTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametri

results: TestCaseResult[]

project: string

ID progetto o nome progetto

runId: number

RunId dell'esecuzione del test

Valori restituiti

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>

Parametri

workItemToTestLinks: WorkItemToTestLinks

project: string

ID progetto o nome progetto

Valori restituiti

Promise<WorkItemToTestLinks>

callbackTestAgent(TestAgentCallbackRequest, string)

function callbackTestAgent(request: TestAgentCallbackRequest, project: string): Promise<boolean>

Parametri

request: TestAgentCallbackRequest

project: string

ID progetto o nome progetto

Valori restituiti

Promise<boolean>

completeGitHubAuth(string, string)

Endpoint di callback OAuth. GitHub reindirizza qui dopo l'autorizzazione dell'utente. Scambia il codice di autorizzazione per i token e li archivia in StrongBox TCM. Richiede la registrazione dell'URL di callback nelle impostazioni dell'app OAuth GitHub.

function completeGitHubAuth(project: string, code: string): Promise<string>

Parametri

project: string

ID progetto o nome progetto

code: string

Codice di autorizzazione restituito da GitHub dopo il consenso dell'utente

Valori restituiti

Promise<string>

createAnalysis(TestSessionAnalysis[], string, number)

Crea un oggetto Analisi sessione nell'archivio dati TCM per una determinata sessione

function createAnalysis(analysis: TestSessionAnalysis[], project: string, sessionId: number): Promise<AnalysisFailureGroupReturn[]>

Parametri

analysis: TestSessionAnalysis[]

Dettagli dell'analisi della sessione

project: string

ID progetto o nome progetto

sessionId: number

ID della sessione per aggiungere la notifica

Valori restituiti

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Crea un allegato nell'archivio log per il valore buildId specificato.

function createBuildAttachmentInLogStore(attachmentRequestModel: TestAttachmentRequestModel, project: string, buildId: number): Promise<void>

Parametri

attachmentRequestModel: TestAttachmentRequestModel

Contiene informazioni sugli allegati, ad esempio stream, filename, comment, attachmentType

project: string

ID progetto o nome progetto

buildId: number

BuildId

Valori restituiti

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Crea un oggetto Environment nell'archivio dati TCM

function createEnvironment(environments: TestSessionEnvironment[], project: string): Promise<void>

Parametri

environments: TestSessionEnvironment[]

Oggetto Environment ricevuto.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Per sessionId specificato, crea oggetti ambiente, configurazione e computer nell'archivio dati TCM

function createEnvironmentAndMachine(sessionEnvironmentAndMachine: SessionEnvironmentAndMachine, project: string, sessionId: number): Promise<void>

Parametri

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

ID progetto o nome progetto

sessionId: number

Valori restituiti

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Crea un nuovo tipo di errore di test

function createFailureType(testResultFailureType: TestResultFailureTypeRequestModel, project: string): Promise<TestResultFailureType>

Parametri

testResultFailureType: TestResultFailureTypeRequestModel

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

Crea un oggetto Notification nell'archivio dati TCM per una determinata sessione

function createNotification(notifications: TestSessionNotification[], project: string, sessionId: number): Promise<number[]>

Parametri

notifications: TestSessionNotification[]

Notifiche da aggiungere per l'ID sessione specificato

project: string

ID progetto o nome progetto

sessionId: number

ID della sessione per aggiungere la notifica

Valori restituiti

Promise<number[]>

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>

Parametri

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

iterationId: number

actionPath: string

Valori restituiti

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Parametri

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

Valori restituiti

Promise<TestAttachmentReference>

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Registra i metadati per un allegato di test a livello di risultato il cui contenuto è già stato caricato nella memoria dedup dal chiamante. La richiesta contiene solo i metadati dell'allegato (id deduplicato, dimensione, nome file, tipo, ecc.) e nessun byte del file.

function createTestResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Parametri

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

Valori restituiti

Promise<TestAttachmentReference>

createTestResultMachines(TestResultMachine[], string, number)

Crea i computer dei risultati del test per l'oggetto TestRunId specificato

function createTestResultMachines(testResultMachines: TestResultMachine[], project: string, runId: number): Promise<void>

Parametri

testResultMachines: TestResultMachine[]

Elenco di computer per i risultati dei test nell'esecuzione

project: string

ID progetto o nome progetto

runId: number

ID di TestRun per aggiungere computer per

Valori restituiti

Promise<void>

createTestRun(RunCreateModel, string)

function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>

Parametri

testRun: RunCreateModel

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Parametri

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestAttachmentReference>

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Registra i metadati di un allegato di test a livello di esecuzione il cui contenuto è già stato caricato nella memoria dedup dal chiamante. La richiesta contiene solo i metadati dell'allegato (id deduplicato, dimensione, nome file, tipo, ecc.) e nessun byte del file.

function createTestRunAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Parametri

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Crea un allegato nell'archivio log per l'id runid specificato.

function createTestRunLogStoreAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestLogStoreAttachmentReference>

Parametri

attachmentRequestModel: TestAttachmentRequestModel

Contiene informazioni sugli allegati, ad esempio stream, filename, comment, attachmentType

project: string

ID progetto o nome progetto

runId: number

Test RunId

Valori restituiti

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

Crea un oggetto TestResultsSession nell'archivio dati TCM

function createTestSession(session: TestResultsSession, project: string): Promise<number>

Parametri

session: TestResultsSession

Oggetto sessione ricevuto.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<number>

createTestSettings(TestSettings, string)

function createTestSettings(testSettings: TestSettings, project: string): Promise<number>

Parametri

testSettings: TestSettings

project: string

ID progetto o nome progetto

Valori restituiti

Promise<number>

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Parametri

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

testSubResultId: number

Valori restituiti

Promise<TestAttachmentReference>

createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)

Registra i metadati di un allegato di test a livello di risultato il cui contenuto è già stato caricato nella memoria dedup dal chiamante. La richiesta contiene solo i metadati dell'allegato (id deduplicato, dimensione, nome file, tipo, ecc.) e nessun byte del file.

function createTestSubResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Parametri

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

testSubResultId: number

Valori restituiti

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

Restituisce i dettagli del campo di test personalizzato per il testExtensionFieldId specificato.

function deleteCustomFieldById(project: string, testExtensionFieldId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

testExtensionFieldId: number

ID campo di test personalizzato che deve essere eliminato.

Valori restituiti

Promise<void>

deleteFailureType(string, number)

Elimina un tipo di errore di test con failureTypeId specificato

function deleteFailureType(project: string, failureTypeId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

failureTypeId: number

Valori restituiti

Promise<void>

deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

Elimina gli ID di riferimento del caso di test inaffidabili tramite informazioni di branch e repository

function deleteFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<number>

Parametri

project: string

ID progetto o nome progetto

repositoryId: string

Guid del repository

branchInfo: BranchInfo

Informazioni sui rami contenenti nome e tipo Nota: Le operazioni su rami protetti come 'master' o 'main' non sono supportate.

Valori restituiti

Promise<number>

deleteTestMethodToWorkItemLink(string, string, number)

function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>

Parametri

project: string

ID progetto o nome progetto

testName: string

workItemId: number

Valori restituiti

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

function deleteTestResultAttachment(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

Valori restituiti

Promise<void>

deleteTestRun(string, number)

function deleteTestRun(project: string, runId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<void>

deleteTestRunAttachment(string, number, number)

function deleteTestRunAttachment(project: string, runId: number, attachmentId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

runId: number

attachmentId: number

Valori restituiti

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Elimina l'allegato con il nome file specificato per il valore runId specificato dall'archivio log.

function deleteTestRunLogStoreAttachment(project: string, runId: number, filename: string): Promise<void>

Parametri

project: string

ID progetto o nome progetto

runId: number

Test RunId

filename: string

Nome file allegato

Valori restituiti

Promise<void>

deleteTestSettings(string, number)

function deleteTestSettings(project: string, testSettingsId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

testSettingsId: number

Valori restituiti

Promise<void>

enhanceCoverage(string, string, number)

Punto d'ingresso cliccabile dal browser per il link "Potenzia la copertura diff" visualizzato nei commenti della copertura PR. Invia un compito coverage_test_generation ad ADOAgenticService per la pull request data e reindirizza l'utente alla pagina pull request.

function enhanceCoverage(project: string, repository: string, pullRequestId: number): Promise<void>

Parametri

project: string

ID progetto o nome progetto

repository: string

pullRequestId: number

Valori restituiti

Promise<void>

fetchSourceCodeCoverageReport(string, number)

function fetchSourceCodeCoverageReport(project: string, buildId: number): Promise<SourceViewBuildCoverage[]>

Parametri

project: string

ID progetto o nome progetto

buildId: number

Valori restituiti

Promise<SourceViewBuildCoverage[]>

generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)

Genera un piano di test manuale da un elemento di lavoro usando l'IA. Se l'utente non ha un token Copilot valido, restituisce needsAuth=true con un authUrl invece di mettere in coda il lavoro.

function generateTestPlanFromWorkItem(generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel, project: string, workItemId: number): Promise<boolean>

Parametri

generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel

project: string

ID progetto o nome progetto

workItemId: number

Valori restituiti

Promise<boolean>

getAfdTcmEndpoint(string)

function getAfdTcmEndpoint(key: string): Promise<string>

Parametri

key: string

Valori restituiti

Promise<string>

getBranchesByFlakyTestCaseRefId(string, number)

Ottenere l'elenco dei rami in cui l'ID di riferimento di un test case si è sfaldato

function getBranchesByFlakyTestCaseRefId(project: string, testCaseReferenceId: number): Promise<TestCaseFlakinessBranchInfo>

Parametri

project: string

ID progetto o nome progetto

testCaseReferenceId: number

ID di riferimento del test utilizzato dal risultato del test

Valori restituiti

Promise<TestCaseFlakinessBranchInfo>

getBugsLinkedToTestResult(string, number, number)

function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

Valori restituiti

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>

Parametri

project: string

ID progetto o nome progetto

buildId: number

flags: number

Valori restituiti

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Richiesta: ID di compilazione e ID di compilazione differenziale (facoltativo)

function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>

Parametri

project: string

ID progetto o nome progetto

buildId: number

deltaBuildId: number

Valori restituiti

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

<p>Ottiene lo stato di copertura per l'ultima compilazione riuscita di una definizione, con ambito facoltativo per un ramo</p specifico>

function getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise<string>

Parametri

project: string

ID progetto o nome progetto

definition: string

ID o nome della definizione.

branchName: string

Nome del ramo.

label: string

Stringa per sostituire il testo predefinito sul lato sinistro del badge.

Valori restituiti

Promise<string>

getFailureTypes(string)

Restituisce l'elenco dei tipi di errore di test.

function getFailureTypes(project: string): Promise<TestResultFailureType[]>

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

Ottenere la copertura dei file per il file specificato

function getFileLevelCodeCoverage(fileCoverageRequest: FileCoverageRequest, project: string): Promise<string>

Parametri

fileCoverageRequest: FileCoverageRequest

Dettagli del file con contesto di iterazione della richiesta pull

project: string

ID progetto o nome progetto

Valori restituiti

Promise<string>

getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

function getFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<TestCaseFlakinessBranchInfo[]>

Parametri

project: string

ID progetto o nome progetto

repositoryId: string

branchInfo: BranchInfo

Valori restituiti

Promise<TestCaseFlakinessBranchInfo[]>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

function getFlakyTestResultsByBuildDefinitionId(project: string, buildDefinitionId: number, minBuildCreatedDate: Date): Promise<TestCaseResult[]>

Parametri

project: string

ID progetto o nome progetto

buildDefinitionId: number

minBuildCreatedDate: Date

Valori restituiti

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

function getFlakyTestResultsByTestRun(project: string, runId: number): Promise<TestCaseResult[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestCaseResult[]>

getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)

Ricevi l'ultimo risultato per ogni TestCaseID richiesto. I casi di test mai eseguiti (nessun risultato in un'esecuzione non cancellata) vengono omessiti dalla risposta: il chiamante considera la loro assenza come "mai eseguito".

function getLatestTestResultsByTestCaseIds(query: TestCaseLatestResultsQuery, project: string): Promise<TestCaseLatestResult[]>

Parametri

query: TestCaseLatestResultsQuery

TestCaseLatestResultsQuery che porta i TestCaseIds da cercare.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestCaseLatestResult[]>

getResultGroupsByBuild(string, number, string, string[], string)

function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Parametri

project: string

ID progetto o nome progetto

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Valori restituiti

Promise<PagedList<FieldDetailsForTestResults>>

getResultGroupsByRelease(string, number, string, number, string[], string)

function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Valori restituiti

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

Recupera gli oggetti TestResultsSession Notification nell'archivio dati TCM

function getSessionNotifications(project: string, sessionId: number): Promise<TestSessionNotification[]>

Parametri

project: string

ID progetto o nome progetto

sessionId: number

ID della sessione TestResults per cui ottenere le notifiche.

Valori restituiti

Promise<TestSessionNotification[]>

getSimilarTestResults(string, number, number, number, number, String)

Ottiene l'elenco dei risultati il cui errore corrisponde a quello fornito.

function getSimilarTestResults(project: string, runId: number, testResultId: number, testSubResultId: number, top?: number, continuationToken?: String): Promise<TestCaseResult[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test

testResultId: number

ID del risultato del test all'interno di un'esecuzione di test

testSubResultId: number

ID del sottoresult all'interno di un risultato del test

top: number

Numero massimo di risultati da restituire

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<TestCaseResult[]>

getTestAgentToken()

Restituisce il token GitHub OAuth dell'utente attuale con il permesso di accedere alle API per Copilot, con un badge di funzionalità bloccato.

function getTestAgentToken(): Promise<string>

Valori restituiti

Promise<string>

getTestIterationAttachmentContent(string, number, number, number, number)

Restituisce un allegato di iterazione di test

function getTestIterationAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Valori restituiti

Promise<ArrayBuffer>

getTestIterationAttachmentZip(string, number, number, number, number)

Restituisce un allegato di iterazione di test

function getTestIterationAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Valori restituiti

Promise<ArrayBuffer>

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

Ottenere un elenco di riferimenti per gli allegati di compilazione

function getTestLogsForBuild(project: string, buildId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione da ottenere

type: TestLogType

tipo dell'allegato da ottenere

directoryPath: string

percorso della directory per cui sono necessari gli allegati

fileNamePrefix: string

prefisso del nome file per filtrare l'elenco di allegati

fetchMetaData: boolean

Il valore predefinito è false, impostare se sono necessari i metadati

top: number

Numero di riferimenti agli allegati di test da restituire

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Ottenere l'URI di firma di accesso condiviso di un allegato di compilazione

function getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

build: number

ID della compilazione da ottenere

type: TestLogType

tipo di file

filePath: string

filePath per il quale è necessario l'URI di firma di accesso condiviso

Valori restituiti

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Ottenere l'URI di firma di accesso condiviso di un allegato dei risultati del test

function getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test che contiene il risultato

resultId: number

ID del risultato del test i cui file devono essere scaricati

type: TestLogType

tipo di file

filePath: string

filePath per il quale è necessario l'URI di firma di accesso condiviso

Valori restituiti

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Ottenere l'URI di firma di accesso condiviso di un allegato di esecuzione del test

function getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test il cui file deve essere scaricato

type: TestLogType

tipo di file

filePath: string

filePath per il quale è necessario l'URI di firma di accesso condiviso

Valori restituiti

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Ottenere l'URI di firma di accesso condiviso di un allegato secondario di test

function getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test che contiene il risultato

resultId: number

ID del risultato del test che contiene subresult

subResultId: number

ID del subresult del test di cui è necessario l'URI sas del file

type: TestLogType

tipo di file

filePath: string

filePath per il quale è necessario l'URI di firma di accesso condiviso

Valori restituiti

Promise<TestLogStoreEndpointDetails>

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

Ottenere un riepilogo dei risultati dei test.

function getTestPipelineMetrics(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, metricNames?: Metrics[], groupByNode?: boolean): Promise<PipelineTestMetrics>

Parametri

project: string

ID progetto o nome progetto

pipelineId: number

ID pipeline. Corrisponde all'ID di compilazione.

stageName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

phaseName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

jobName: string

La matrice in YAML genera copie di un processo con input diversi nella matrice. JobName è il nome di tali input. La lunghezza massima supportata per il nome è 256 caratteri.

metricNames: Metrics[]

groupByNode: boolean

Riepilogo del gruppo per ogni nodo dell'erede pi**

Valori restituiti

Promise<PipelineTestMetrics>

getTestResultAttachmentContent(string, number, number, number)

Restituisce un allegato dei risultati del test

function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

Valori restituiti

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

Valori restituiti

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Restituisce un allegato dei risultati del test

function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

Valori restituiti

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

function getTestResultById(project: string, runId: number, testResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>

Parametri

project: string

ID progetto o nome progetto

runId: number

testResultId: number

detailsToInclude: ResultDetails

Valori restituiti

Promise<TestCaseResult>

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)

Ottenere un riepilogo dei risultati dei test per una compilazione. Per recuperare l'intero TestCaseResult, chiamare Results - Get.

function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametri

project: string

ID progetto o nome progetto

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Valori restituiti

Promise<TestResultsDetails>

getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)

function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Valori restituiti

Promise<TestResultsDetails>

getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

Ottenere un elenco di riferimenti ai risultati del test

function getTestResultLogs(project: string, runId: number, resultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test che contiene il risultato

resultId: number

ID del risultato del test

type: TestLogType

tipo di allegati da ottenere

directoryPath: string

percorso della directory degli allegati da ottenere

fileNamePrefix: string

prefisso del nome file per filtrare l'elenco di allegati

fetchMetaData: boolean

Il valore predefinito è false, impostare se sono necessari i metadati

top: number

Numbe di riferimenti agli allegati da restituire

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<PagedList<TestLog>>

getTestResultMachines(string, number)

Ottiene i computer dei risultati del test per l'oggetto TestRunId specificato

function getTestResultMachines(project: string, runId: number): Promise<TestResultMachine[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID di TestRun per aggiungere computer per

Valori restituiti

Promise<TestResultMachine[]>

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Valori restituiti

Promise<TestCaseResult[]>

getTestResultsByBuild(string, number, string, TestOutcome[], number, string)

function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Parametri

project: string

ID progetto o nome progetto

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Valori restituiti

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)

Ottenere un elenco di risultati.

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<ShallowTestCaseResult>>

Parametri

project: string

ID progetto o nome progetto

pipelineId: number

ID pipeline. Corrisponde all'ID di compilazione.

stageName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

phaseName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

jobName: string

La matrice in YAML genera copie di un processo con input diversi nella matrice. JobName è il nome di tali input. La lunghezza massima supportata per il nome è 256 caratteri.

outcomes: TestOutcome[]

Elenco dei risultati dei risultati

includeAllBuildRuns: boolean

Indica se includere o meno esecuzioni di test da tutte le esecuzioni di compilazione.

top: number

Numero massimo di risultati da restituire

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)

Ottiene gli oggetti TestCaseResult completi con dettagli 1MRX per il valore pipelineId specificato

function getTestResultsByPipelineMRX(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestCaseResult>>

Parametri

project: string

ID progetto o nome progetto

pipelineId: number

ID pipeline. Corrisponde all'ID di compilazione.

stageName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

phaseName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

jobName: string

La matrice in YAML genera copie di un processo con input diversi nella matrice. JobName è il nome di tali input. La lunghezza massima supportata per il nome è 256 caratteri.

outcomes: TestOutcome[]

Elenco dei risultati dei risultati

includeAllBuildRuns: boolean

Indica se includere o meno esecuzioni di test da tutte le esecuzioni di compilazione. Il valore predefinito è falso.

top: number

Numero massimo di risultati da restituire. Il valore predefinito è 10000.

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<PagedList<TestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>

Parametri

query: TestResultsQuery

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestResultsQuery>

getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)

function getTestResultsByQueryWiql(queryModel: QueryModel, project: string, includeResultDetails?: boolean, includeIterationDetails?: boolean, skip?: number, top?: number): Promise<TestCaseResult[]>

Parametri

queryModel: QueryModel

project: string

ID progetto o nome progetto

includeResultDetails: boolean

includeIterationDetails: boolean

skip: number

top: number

Valori restituiti

Promise<TestCaseResult[]>

getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)

function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Valori restituiti

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsSettings(string, TestResultsSettingsType)

Ottenere dati TestResultsSettings

function getTestResultsSettings(project: string, settingsType?: TestResultsSettingsType): Promise<TestResultsSettings>

Parametri

project: string

ID progetto o nome progetto

settingsType: TestResultsSettingsType

Valori restituiti

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

function getTestResultWorkItemsById(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

Valori restituiti

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

Restituisce un allegato di esecuzione del test

function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

attachmentId: number

Valori restituiti

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestAttachment[]>

getTestRunAttachmentUploadDetails(string, number)

Pre-flight per un caricamento allegato diretto a BlobStore: applica il permesso di pubblicazione e restituisce il dominio dedup a cui pubblicare. L'agente chiama questo prima di caricare qualsiasi byte.

function getTestRunAttachmentUploadDetails(project: string, runId: number): Promise<TestAttachmentUploadDetails>

Parametri

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestAttachmentUploadDetails>

getTestRunAttachmentZip(string, number, number)

Restituisce un allegato di esecuzione del test

function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

attachmentId: number

Valori restituiti

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

function getTestRunById(project: string, runId: number, includeDetails?: boolean, includeTags?: boolean): Promise<TestRun>

Parametri

project: string

ID progetto o nome progetto

runId: number

includeDetails: boolean

includeTags: boolean

Valori restituiti

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

flags: number

Valori restituiti

Promise<TestRunCoverage[]>

getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

Ottenere l'elenco dei riferimenti agli allegati di esecuzione dei test

function getTestRunLogs(project: string, runId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test

type: TestLogType

tipo di allegati da ottenere

directoryPath: string

percorso della directory per cui sono necessari gli allegati

fileNamePrefix: string

prefisso del nome file per filtrare l'elenco di allegati

fetchMetaData: boolean

Il valore predefinito è false, impostare se sono necessari i metadati

top: number

Numero di riferimenti allegati da restituire

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Restituisce l'allegato con il nome file specificato per il valore runId specificato da LogStore.

function getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

Test RunId

filename: string

Nome file allegato

Valori restituiti

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Restituisce un elenco di allegati per l'id runId specificato dall'archivio log.

function getTestRunLogStoreAttachments(project: string, runId: number): Promise<TestLogStoreAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

Test RunId

Valori restituiti

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

Restituisce l'allegato con il nome file specificato per il valore runId specificato da LogStore.

function getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

Test RunId

filename: string

Nome file allegato

Valori restituiti

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

Ottenere i log dei messaggi di esecuzione del test

function getTestRunMessageLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione da ottenere.

Valori restituiti

Promise<TestMessageLogDetails[]>

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>

Parametri

project: string

ID progetto o nome progetto

buildUri: string

owner: string

tmiRunId: string

planId: number

includeRunDetails: boolean

automated: boolean

skip: number

top: number

Valori restituiti

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

Recupera le esecuzioni di test associate a una sessione

function getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>

Parametri

project: string

ID progetto o nome progetto

sessionId: number

ID della sessione TestResults per cui ottenere le esecuzioni di test.

Valori restituiti

Promise<number[]>

getTestRunStatistics(string, number)

Ottenere le statistiche di esecuzione dei test , usate quando si vuole ottenere un riepilogo di un'esecuzione in base al risultato.

function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione da ottenere.

Valori restituiti

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Ottenere il riepilogo dell'esecuzione dei test, usato quando si vuole ottenere un riepilogo di un'esecuzione in base al risultato. L'esecuzione dei test deve essere completata.

function getTestRunSummaryByOutcome(project: string, runId: number): Promise<TestRunStatistic>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione da ottenere.

Valori restituiti

Promise<TestRunStatistic>

getTestSession(string, number)

Recupera l'oggetto metadati TestResultsSession nell'archivio dati TCM

function getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>

Parametri

project: string

ID progetto o nome progetto

buildId: number

Valori restituiti

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Recupera l'oggetto Layout TestResultsSession nell'archivio dati TCM

function getTestSessionLayout(project: string, sessionId: string): Promise<any[]>

Parametri

project: string

ID progetto o nome progetto

sessionId: string

Valori restituiti

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Recupera l'oggetto Layout TestResultsSession nell'archivio dati TCM

function getTestSessionLayoutBySessionId(project: string, sessionId: number): Promise<any[]>

Parametri

project: string

ID progetto o nome progetto

sessionId: number

Recuperare l'oggetto sessione.

Valori restituiti

Promise<any[]>

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestSessionResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Valori restituiti

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>

Parametri

project: string

ID progetto o nome progetto

testSettingsId: number

Valori restituiti

Promise<TestSettings>

getTestSubResultAttachmentContent(string, number, number, number, number)

Restituisce un allegato di risultati secondari del test

function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Valori restituiti

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Restituisce i riferimenti agli allegati per il risultato secondario del test.

function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

testSubResultId: number

Valori restituiti

Promise<TestAttachment[]>

getTestSubResultAttachmentZip(string, number, number, number, number)

Restituisce un allegato di risultati secondari del test

function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Valori restituiti

Promise<ArrayBuffer>

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

Ottenere l'elenco di riferimenti ai sottoresult di test

function getTestSubResultLogs(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test che contiene i risultati

resultId: number

ID del risultato del test che contiene subresult

subResultId: number

ID del subresult del test

type: TestLogType

tipo di allegati da ottenere

directoryPath: string

percorso della directory dell'allegato da ottenere

fileNamePrefix: string

prefisso del nome file per filtrare l'elenco di allegati

fetchMetaData: boolean

Il valore predefinito è false, impostare se sono necessari i metadati

top: number

Numero di riferimenti allegati da restituire

continuationToken: String

Intestazione per passare il continuationToken

Valori restituiti

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Ottenere tutti i tag in una compilazione.

function getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID compilazione

Valori restituiti

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Ottenere tutti i tag in una versione.

function getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTag[]>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

ID versione

releaseEnvId: number

ID dell'ambiente di rilascio

Valori restituiti

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Ottenere tutti i tag in una compilazione.

function getTestTagSummaryForBuild(project: string, buildId: number): Promise<TestTagSummary>

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID compilazione

Valori restituiti

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Ottenere tutti i tag in una versione.

function getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTagSummary>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

ID versione

releaseEnvId: number

ID dell'ambiente di rilascio

Valori restituiti

Promise<TestTagSummary>

getTestWeightedScoreByTestRun(string, string, boolean, boolean)

Calcolare il punteggio ponderato del test per una data lista separata di ID delle corse di test.

function getTestWeightedScoreByTestRun(project: string, runIds: string, includeAllOutcomes?: boolean, onlyFlakyResults?: boolean): Promise<TestCaseResult[]>

Parametri

project: string

ID progetto o nome progetto

runIds: string

Comman separò gli ID delle prove di prova. Massimo 100 supportati.

includeAllOutcomes: boolean

Includere tutti i risultati dei test per il calcolo TWS. Per impostazione predefinita, si considera falso

onlyFlakyResults: boolean

Opzione di restituire solo i risultati dei test inattivi identificati come inattivi. Per impostazione predefinita, vero viene passato

Valori restituiti

Promise<TestCaseResult[]>

publishTestResultDocument(TestResultDocument, string, number)

function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>

Parametri

document: TestResultDocument

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

Restituisce l'elenco dei campi di test personalizzati per l'ambito del campo di test personalizzato specificato.

function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>

Parametri

project: string

ID progetto o nome progetto

scopeFilter: CustomTestFieldScope

Ambito dei campi di test personalizzati che devono essere restituiti.

Valori restituiti

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Parametri

filter: TestResultTrendFilter

project: string

ID progetto o nome progetto

Valori restituiti

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Parametri

filter: TestResultTrendFilter

project: string

ID progetto o nome progetto

Valori restituiti

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Ottenere la cronologia di un metodo di test usando TestHistoryQuery

function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>

Parametri

filter: TestHistoryQuery

TestHistoryQuery per ottenere la cronologia

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>

Parametri

project: string

ID progetto o nome progetto

testName: string

Valori restituiti

Promise<TestToWorkItemLinks>

queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)

Restituisce metadati per gli allegati di test supportati da BlobStore a livello di risultato il cui nome file inizia con fileNamePrefix, o per il singolo allegato identificato da attachmentId quando viene fornito.

function queryTestResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Valori restituiti

Promise<BlobStoreTestAttachment[]>

queryTestResultHistory(ResultsFilter, string)

function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>

Parametri

filter: ResultsFilter

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

Ottenere l'elenco dei metadati dei risultati del test per il testcasereferenceId corrispondente

function queryTestResultsMetaData(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

Parametri

testCaseReferenceIds: string[]

Id TestCaseReference del risultato del test su cui eseguire una query, elenco delimitato da virgole di ID validi (limite n. di ID 200).

project: string

ID progetto o nome progetto

detailsToInclude: ResultMetaDataDetails

Dettagli da includere con i metadati dei risultati del test. Il valore predefinito è Nessuno. Altri valori sono FlakyIdentifiers.

Valori restituiti

Promise<TestResultMetaData[]>

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)

function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>

Parametri

project: string

ID progetto o nome progetto

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Valori restituiti

Promise<TestResultSummary>

queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

Ottenere un riepilogo dei risultati dei test.

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): Promise<TestResultSummary>

Parametri

project: string

ID progetto o nome progetto

pipelineId: number

ID pipeline. Corrisponde all'ID di compilazione.

stageName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

phaseName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

jobName: string

La matrice in YAML genera copie di un processo con input diversi nella matrice. JobName è il nome di tali input. La lunghezza massima supportata per il nome è 256 caratteri.

includeFailureDetails: boolean

Se true restituisce informazioni dettagliate sugli errori

Valori restituiti

Promise<TestResultSummary>

queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)

function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Valori restituiti

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>

Parametri

releases: ReleaseReference[]

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestResultSummary[]>

queryTestResultWorkItems(string, string, string, number, Date, number, number)

Query Test Result WorkItems basato sul filtro

function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>

Parametri

project: string

ID progetto o nome progetto

workItemCategory: string

può accettare valori Microsoft.BugCategory o all(per ottenere tutti gli elementi di lavoro)

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Valori restituiti

Promise<WorkItemReference[]>

queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)

Restituisce metadati per gli allegati di test supportati da BlobStore a livello di run il cui nome file inizia con fileNamePrefix, o per il singolo allegato identificato da attachmentId quando viene fornito. L'agente utilizza questo per enumerare i log di test BlobStore (dedup), che non sono presenti nel contenitore SAS classico di LogStore e quindi non possono essere elencati direttamente dall'agente.

function queryTestRunAttachmentsMetadata(project: string, runId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Valori restituiti

Promise<BlobStoreTestAttachment[]>

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)

Esecuzione di test di query in base ai filtri. I campi obbligatori sono minLastUpdatedDate e maxLastUpdatedDate.

function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, sortOrder?: TestRunSortOrderType, continuationToken?: string): Promise<PagedList<TestRun>>

Parametri

project: string

ID progetto o nome progetto

minLastUpdatedDate: Date

Data minima ultima modifica dell'esecuzione su cui eseguire una query (obbligatorio).

maxLastUpdatedDate: Date

Data massima dell'ultima modifica dell'esecuzione su cui eseguire una query (obbligatorio, differenza tra min e max date può essere il massimo 7 giorni).

state: TestRunState

Stato corrente delle esecuzioni su cui eseguire query.

planIds: number[]

ID piano delle esecuzioni su cui eseguire query, elenco delimitato da virgole di ID validi.

isAutomated: boolean

Tipo di automazione delle esecuzioni su cui eseguire query.

publishContext: TestRunPublishContext

PublishContext delle esecuzioni su cui eseguire query.

buildIds: number[]

ID di compilazione delle esecuzioni su cui eseguire query, elenco delimitato da virgole di ID validi.

buildDefIds: number[]

ID definizione di compilazione delle esecuzioni su cui eseguire query, elenco delimitato da virgole di ID validi.

branchName: string

Nome del ramo di origine delle esecuzioni su cui eseguire query.

releaseIds: number[]

ID versione delle esecuzioni su cui eseguire una query, elenco delimitato da virgole di ID validi.

releaseDefIds: number[]

ID definizione versione delle esecuzioni su cui eseguire query, elenco delimitato da virgole di ID validi.

releaseEnvIds: number[]

Id ambiente di rilascio delle esecuzioni su cui eseguire query, elenco delimitato da virgole di ID validi.

releaseEnvDefIds: number[]

Id definizione dell'ambiente di rilascio delle esecuzioni su cui eseguire query, elenco delimitato da virgole di ID validi.

runTitle: string

Eseguire il titolo delle esecuzioni su cui eseguire una query.

top: number

Numero di esecuzioni su cui eseguire query. Il limite è 100

sortOrder: TestRunSortOrderType

Ordinare in base a LastUpdated per le esecuzioni di test.

continuationToken: string

continuationToken ricevuto dal batch precedente o null per il primo batch. Non deve essere creato (o modificato, se ricevuto dall'ultimo batch) dall'utente.

Valori restituiti

Promise<PagedList<TestRun>>

queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)

Restituisce metadati per gli allegati di test supportati da BlobStore a livello di risultato inferiore il cui nome file inizia con fileNamePrefix, o per il singolo allegato identificato da attachmentId quando viene fornito.

function queryTestSubResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, testSubResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parametri

project: string

ID progetto o nome progetto

runId: number

testCaseResultId: number

testSubResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Valori restituiti

Promise<BlobStoreTestAttachment[]>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>

Parametri

resultsContext: TestResultsContext

project: string

ID progetto o nome progetto

workItemIds: number[]

Valori restituiti

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Creare e ottenere l'URI sas del contenitore di compilazione

function testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: TestLogStoreOperationType): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione da ottenere

testLogStoreOperationType: TestLogStoreOperationType

Tipo di operazione da eseguire con l'URI di firma di accesso condiviso

Valori restituiti

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Creare un file vuoto per un risultato e ottenere l'URI di firma di accesso condiviso per il file

function testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: TestLogType): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test che contiene il risultato

resultId: number

ID dei risultati del test che contiene il risultato secondario

subResultId: number

ID del risultato secondario del test di cui è necessario l'URI sas del file

filePath: string

percorso del file all'interno del risultato secondario per il quale è necessario l'URI di firma di accesso condiviso

type: TestLogType

Tipo di file da scaricare

Valori restituiti

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Creare un file vuoto per un'esecuzione e ottenere l'URI di firma di accesso condiviso per il file

function testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: TestLogStoreOperationType, filePath?: string, type?: TestLogType): Promise<TestLogStoreEndpointDetails>

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione per ottenere i dettagli dell'endpoint

testLogStoreOperationType: TestLogStoreOperationType

Tipo di operazione da eseguire con l'URI di firma di accesso condiviso

filePath: string

percorso del file per creare un file vuoto

type: TestLogType

Il valore predefinito è GeneralAttachment, tipo di file vuoto da creare

Valori restituiti

Promise<TestLogStoreEndpointDetails>

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

Ottenere tutti i dettagli dei gruppi disponibili e per questi gruppi vengono restituiti risultati non riusciti e interrotti.

function testResultsGroupDetails(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, shouldIncludeFailedAndAbortedResults?: boolean, queryGroupSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametri

project: string

ID progetto o nome progetto

pipelineId: number

ID pipeline. Corrisponde all'ID di compilazione.

stageName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

phaseName: string

Nome della fase. La lunghezza massima supportata per il nome è 256 caratteri.

jobName: string

La matrice in YAML genera copie di un processo con input diversi nella matrice. JobName è il nome di tali input. La lunghezza massima supportata per il nome è 256 caratteri.

shouldIncludeFailedAndAbortedResults: boolean

Se true, restituirà id di risultati non riusciti e interrotti per ogni gruppo di test

queryGroupSummaryForInProgress: boolean

Se true, verrà calcolato anche il riepilogo per le esecuzioni di InProgress.

Valori restituiti

Promise<TestResultsDetails>

triggerTestAgent(TestAgentTriggerRequest, string)

function triggerTestAgent(request: TestAgentTriggerRequest, project: string): Promise<boolean>

Parametri

request: TestAgentTriggerRequest

project: string

ID progetto o nome progetto

Valori restituiti

Promise<boolean>

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Richiesta: Json del riepilogo della copertura del codice

function updateCodeCoverageSummary(project: string, buildId: number, coverageData?: CodeCoverageData): Promise<void>

Parametri

project: string

ID progetto o nome progetto

buildId: number

coverageData: CodeCoverageData

Valori restituiti

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

Restituisce i dettagli del campo di test personalizzato che viene aggiornato.

function updateCustomField(updateCustomTestField: CustomTestFieldUpdateDefinition, project: string): Promise<CustomTestFieldDefinition>

Parametri

updateCustomTestField: CustomTestFieldUpdateDefinition

Campo di test personalizzato che deve essere aggiornato.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

Aggiornare le impostazioni del progetto dei risultati dei test

function updatePipelinesTestSettings(testResultsUpdateSettings: TestResultsUpdateSettings, project: string): Promise<TestResultsSettings>

Parametri

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

ID progetto o nome progetto

Valori restituiti

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametri

results: TestCaseResult[]

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Aggiornare le proprietà dei metadati dei risultati del test

function updateTestResultsMetaData(testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput, project: string, testCaseReferenceId: number): Promise<TestResultMetaData>

Parametri

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData input di aggiornamento TestResultMetaDataUpdateInput

project: string

ID progetto o nome progetto

testCaseReferenceId: number

Id testCaseReference del risultato del test da aggiornare.

Valori restituiti

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Crea oggetti TestResultsMRX nell'archivio dati TCM per i risultati dei test esistenti

function updateTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<number[]>

Parametri

results: TestCaseResult[]

Oggetto Results con solo i risultati dei test delle proprietà MRX e testResultId esistente

project: string

ID progetto o nome progetto

runId: number

RunId dell'esecuzione del test

Valori restituiti

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>

Parametri

runUpdateModel: RunUpdateModel

project: string

ID progetto o nome progetto

runId: number

Valori restituiti

Promise<TestRun>

updateTestRunsBySessionId(TestSessionTestRun, string, number)

Aggiorna le esecuzioni di test associate a una sessione

function updateTestRunsBySessionId(testRunIds: TestSessionTestRun, project: string, sessionId: number): Promise<number[]>

Parametri

testRunIds: TestSessionTestRun

project: string

ID progetto o nome progetto

sessionId: number

ID della sessione TestResults per cui aggiornare le esecuzioni di test.

Valori restituiti

Promise<number[]>

updateTestRunTags(TestTagsUpdateModel, string, number)

Aggiornare i tag di un'esecuzione, i tag possono essere aggiunti ed eliminati

function updateTestRunTags(testTagsUpdateModel: TestTagsUpdateModel, project: string, runId: number): Promise<TestTag[]>

Parametri

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

ID progetto o nome progetto

runId: number

RunId dell'esecuzione

Valori restituiti

Promise<TestTag[]>

updateTestSession(TestResultsSession, string, number)

Aggiorna l'oggetto sessione di test associato a un sessionId

function updateTestSession(session: TestResultsSession, project: string, sessionId: number): Promise<number>

Parametri

session: TestResultsSession

Aggiornare l'oggetto Session

project: string

ID progetto o nome progetto

sessionId: number

ID della sessione TestResults per cui aggiornare l'oggetto sessione di test.

Valori restituiti

Promise<number>

TestResultsRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

TestResultsRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

addCustomFields(CustomTestFieldDefinition[], string)

Parametri

Valori restituiti

addTestResultsToTestRun(TestCaseResult[], string, number)

Parametri

Valori restituiti

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Parametri

Valori restituiti

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parametri

Valori restituiti

callbackTestAgent(TestAgentCallbackRequest, string)

Parametri

Valori restituiti

completeGitHubAuth(string, string)

Parametri

Valori restituiti

createAnalysis(TestSessionAnalysis[], string, number)

Parametri

Valori restituiti

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Parametri

Valori restituiti

createEnvironment(TestSessionEnvironment[], string)

Parametri

Valori restituiti

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Parametri

Valori restituiti

createFailureType(TestResultFailureTypeRequestModel, string)

Parametri

Valori restituiti

createNotification(TestSessionNotification[], string, number)

Parametri

Valori restituiti

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Parametri

Valori restituiti

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parametri

Valori restituiti

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Parametri

Valori restituiti

createTestResultMachines(TestResultMachine[], string, number)

Parametri

Valori restituiti

createTestRun(RunCreateModel, string)

Parametri

Valori restituiti

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parametri

Valori restituiti

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Parametri

Valori restituiti

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Parametri

Valori restituiti

createTestSession(TestResultsSession, string)

Parametri

Valori restituiti

createTestSettings(TestSettings, string)

Parametri

Valori restituiti

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Parametri

Valori restituiti