Condividi tramite


TestResultsRestClient class

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

Extends

Costruttori

TestResultsRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addCustomFields(CustomTestFieldDefinition[], string)
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)

Aggiungere risultati test alla sessione di esecuzione del test

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

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

createEnvironment(TestSessionEnvironment[], string)

Crea un oggetto Environment nell'archivio dati TCM

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Per l'id sessione 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)
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Crea un allegato nell'archivio log per il runId specificato.

createTestSession(TestResultsSession, string)

Crea un oggetto TestResultsSession nell'archivio dati TCM

createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
deleteCustomFieldById(string, number)
deleteFailureType(string, number)

Elimina un tipo di errore di test con failureTypeId specificato

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 runId specificato da LogStore.

deleteTestSettings(string, number)
fetchSourceCodeCoverageReport(string, number)
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 compilazione e ID build differenziale (facoltativo)

getCoverageStatusBadge(string, string, string, string)

<p>Ottiene lo stato di copertura per l'ultima compilazione riuscita di una definizione, facoltativamente con ambito a 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

getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
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 i cui errori corrispondono a quello specificato.

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 di test subresults

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

Ottenere il 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)
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

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)

Ottenere un elenco di risultati.

getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)

Ottenere i dati TestResultsSettings

getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)

Restituisce un allegato di esecuzione del test

getTestRunAttachments(string, number)
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 un elenco di riferimenti all'esecuzione di test

getTestRunLogStoreAttachmentContent(string, number, string)

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

getTestRunLogStoreAttachments(string, number)

Restituisce un elenco di allegati per il runId specificato da LogStore.

getTestRunLogStoreAttachmentZip(string, number, string)

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

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 il riepilogo di un'esecuzione per risultato.

getTestRunSummaryByOutcome(string, number)

Ottenere il riepilogo dell'esecuzione del test, usato quando si vuole ottenere il riepilogo di un'esecuzione per risultato. L'esecuzione del test deve essere in stato completato.

getTestSession(string, number)

Recupera l'oggetto metadati TestResultsSession nell'archivio dati TCM

getTestSessionLayout(string, string)

Recupera l'oggetto TestResultsSession Layout nell'archivio dati TCM

getTestSessionLayoutBySessionId(string, number)

Recupera l'oggetto TestResultsSession Layout 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 dei sottoresult allegati 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.

publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)

Ottenere la cronologia di un metodo di test usando TestHistoryQuery

queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

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

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

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

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

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

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 sas per il file

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

Creare un file vuoto per un'esecuzione e ottenere l'URI sas per il file

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

Ottenere tutti i dettagli dei gruppi disponibili e per questi gruppi si ottengono risultati non riusciti e interrotti.

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary summary

updateCustomField(CustomTestFieldUpdateDefinition, string)
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)
updateTestRunTags(TestTagsUpdateModel, string, number)

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

Dettagli costruttore

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addCustomFields(CustomTestFieldDefinition[], string)

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

Parametri

project

string

ID progetto o nome del progetto

Restituisce

addTestResultsToTestRun(TestCaseResult[], string, number)

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

Parametri

results

TestCaseResult[]

project

string

ID progetto o nome del progetto

runId

number

Restituisce

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Aggiungere risultati test alla sessione di esecuzione del test

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

Parametri

results

TestCaseResult[]

project

string

ID progetto o nome del progetto

runId

number

RunId dell'esecuzione del test

Restituisce

Promise<TestCaseResult[]>

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

Parametri

workItemToTestLinks
WorkItemToTestLinks
project

string

ID progetto o nome del progetto

Restituisce

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Crea un allegato nell'archivio log per il 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 del progetto

buildId

number

BuildId

Restituisce

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

Restituisce

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Per l'id sessione 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 del progetto

sessionId

number

Restituisce

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

Restituisce

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

sessionId

number

ID della sessione per aggiungere la notifica

Restituisce

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

runId

number

testCaseResultId

number

iterationId

number

actionPath

string

Restituisce

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

runId

number

testCaseResultId

number

Restituisce

createTestRun(RunCreateModel, string)

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

Parametri

testRun
RunCreateModel
project

string

ID progetto o nome del progetto

Restituisce

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

runId

number

Restituisce

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Crea un allegato nell'archivio log per il 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 del progetto

runId

number

Test RunId

Restituisce

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

Restituisce

Promise<number>

createTestSettings(TestSettings, string)

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

Parametri

testSettings
TestSettings
project

string

ID progetto o nome del progetto

Restituisce

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

runId

number

testCaseResultId

number

testSubResultId

number

Restituisce

deleteCustomFieldById(string, number)

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

Parametri

project

string

ID progetto o nome del progetto

testExtensionFieldId

number

Restituisce

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

failureTypeId

number

Restituisce

Promise<void>

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

Parametri

project

string

ID progetto o nome del progetto

testName

string

workItemId

number

Restituisce

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

runId

number

testCaseResultId

number

attachmentId

number

Restituisce

Promise<void>

deleteTestRun(string, number)

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

Parametri

project

string

ID progetto o nome del progetto

runId

number

Restituisce

Promise<void>

deleteTestRunAttachment(string, number, number)

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

Parametri

project

string

ID progetto o nome del progetto

runId

number

attachmentId

number

Restituisce

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

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

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

Parametri

project

string

ID progetto o nome del progetto

runId

number

Test RunId

filename

string

Attachment FileName

Restituisce

Promise<void>

deleteTestSettings(string, number)

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

Parametri

project

string

ID progetto o nome del progetto

testSettingsId

number

Restituisce

Promise<void>

fetchSourceCodeCoverageReport(string, number)

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

Parametri

project

string

ID progetto o nome del progetto

buildId

number

Restituisce

getBugsLinkedToTestResult(string, number, number)

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

Parametri

project

string

ID progetto o nome del progetto

runId

number

testCaseResultId

number

Restituisce

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

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

Parametri

project

string

ID progetto o nome del progetto

buildId

number

flags

number

Restituisce

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

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

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

Parametri

project

string

ID progetto o nome del progetto

buildId

number

deltaBuildId

number

Restituisce

getCoverageStatusBadge(string, string, string, string)

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

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

Parametri

project

string

ID progetto o nome del 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.

Restituisce

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

Restituisce

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

Restituisce

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

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

Parametri

project

string

ID progetto o nome del progetto

buildDefinitionId

number

minBuildCreatedDate

Date

Restituisce

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

Parametri

project

string

ID progetto o nome del progetto

runId

number

Restituisce

Promise<TestCaseResult[]>

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

buildId

number

publishContext

string

fields

string[]

continuationToken

string

Restituisce

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

releaseId

number

publishContext

string

releaseEnvId

number

fields

string[]

continuationToken

string

Restituisce

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 ottenere notifiche.

Restituisce

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

Ottiene l'elenco dei risultati i cui errori corrispondono a quello specificato.

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 di sottoresult all'interno di un risultato del test

top

number

Numero massimo di risultati da restituire

continuationToken

String

Intestazione per passare la continuazioneToken

Restituisce

Promise<TestCaseResult[]>

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

Restituisce

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

Restituisce

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 directory per i quali allegati sono necessari

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

Restituisce

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

filePath

string

filePath per cui è necessario l'uri sas

Restituisce

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 contenente il risultato

resultId

number

ID del risultato del test i cui file devono essere scaricati

type
TestLogType

tipo del file

filePath

string

filePath per cui è necessario l'uri sas

Restituisce

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

filePath

string

filePath per cui è necessario l'uri sas

Restituisce

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

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

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 contenente il risultato

resultId

number

ID del risultato del test contenente sottoresult

subResultId

number

ID della sottoresult di test di cui è necessario l'uri sas del file

type
TestLogType

tipo del file

filePath

string

filePath per cui è necessario l'uri sas

Restituisce

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

Ottenere il 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. Lunghezza massima supportata per il nome è 256 caratteri.

phaseName

string

Nome della fase. 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. Lunghezza massima supportata per il nome è 256 caratteri.

metricNames

Metrics[]

groupByNode

boolean

Riepilogo del gruppo per ogni nodo dell'erede pipleine

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

Promise<TestCaseResult>

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

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

Restituisce

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

Restituisce

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 contenente il risultato

resultId

number

ID del risultato del test

type
TestLogType

tipo di allegati da ottenere

directoryPath

string

percorso 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 dei riferimenti agli allegati da restituire

continuationToken

String

Intestazione per passare la continuazioneToken

Restituisce

Promise<PagedList<TestLog>>

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

Restituisce

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

Restituisce

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

Ottenere un elenco di risultati.

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], 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. Lunghezza massima supportata per il nome è 256 caratteri.

phaseName

string

Nome della fase. 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. Lunghezza massima supportata per il nome è 256 caratteri.

outcomes

TestOutcome[]

Elenco dei risultati dei risultati

top

number

Numero massimo di risultati da restituire

continuationToken

String

Intestazione per passare la continuazioneToken

Restituisce

getTestResultsByQuery(TestResultsQuery, string)

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

Parametri

project

string

ID progetto o nome progetto

Restituisce

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

Restituisce

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

Restituisce

getTestResultsSettings(string, TestResultsSettingsType)

Ottenere i dati TestResultsSettings

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

Parametri

project

string

ID progetto o nome progetto

Restituisce

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

Restituisce

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

Restituisce

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

Parametri

project

string

ID progetto o nome progetto

runId

number

Restituisce

Promise<TestAttachment[]>

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

Restituisce

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

Restituisce

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

Restituisce

Promise<TestRunCoverage[]>

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

Ottenere un elenco di riferimenti all'esecuzione di 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 degli allegati da ottenere

directoryPath

string

percorso directory per i quali allegati sono necessari

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

continuationToken

String

Intestazione per passare la continuazioneToken

Restituisce

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

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

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

Parametri

project

string

ID progetto o nome progetto

runId

number

Test RunId

filename

string

FileName allegato

Restituisce

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Restituisce un elenco di allegati per il runId specificato da LogStore.

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

Parametri

project

string

ID progetto o nome progetto

runId

number

Test RunId

Restituisce

getTestRunLogStoreAttachmentZip(string, number, string)

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

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

Parametri

project

string

ID progetto o nome progetto

runId

number

Test RunId

filename

string

FileName allegato

Restituisce

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.

Restituisce

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

Restituisce

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 ottenere esecuzioni di test.

Restituisce

Promise<number[]>

getTestRunStatistics(string, number)

Ottenere le statistiche di esecuzione dei test, usate quando si vuole ottenere il riepilogo di un'esecuzione per risultato.

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

Parametri

project

string

ID progetto o nome progetto

runId

number

ID dell'esecuzione da ottenere.

Restituisce

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Ottenere il riepilogo dell'esecuzione del test, usato quando si vuole ottenere il riepilogo di un'esecuzione per risultato. L'esecuzione del test deve essere in stato completato.

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

Parametri

project

string

ID progetto o nome progetto

runId

number

ID dell'esecuzione da ottenere.

Restituisce

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

Restituisce

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Recupera l'oggetto TestResultsSession Layout nell'archivio dati TCM

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

Parametri

project

string

ID progetto o nome progetto

sessionId

string

Restituisce

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Recupera l'oggetto TestResultsSession Layout 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.

Restituisce

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

Restituisce

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

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

Parametri

project

string

ID progetto o nome progetto

testSettingsId

number

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

Promise<ArrayBuffer>

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

Ottenere l'elenco dei sottoresult allegati 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 contenente i risultati

resultId

number

ID del risultato del test contenente sottoresult

subResultId

number

ID della sottoresult del test

type
TestLogType

tipo degli allegati da ottenere

directoryPath

string

percorso 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 agli allegati da restituire

continuationToken

String

Intestazione per passare la continuazioneToken

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

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

Restituisce

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

Parametri

project

string

ID progetto o nome progetto

runId

number

Restituisce

queryCustomFields(string, CustomTestFieldScope)

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

Parametri

project

string

ID progetto o nome progetto

scopeFilter
CustomTestFieldScope

Restituisce

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parametri

project

string

ID progetto o nome progetto

Restituisce

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parametri

project

string

ID progetto o nome progetto

Restituisce

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

Restituisce

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parametri

project

string

ID progetto o nome progetto

testName

string

Restituisce

queryTestResultHistory(ResultsFilter, string)

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

Parametri

filter
ResultsFilter
project

string

ID progetto o nome progetto

Restituisce

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

Ottenere l'elenco dei dettagli 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 da eseguire 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. L'impostazione predefinita è None. Altri valori sono FlakyIdentifiers.

Restituisce

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

Restituisce

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

Ottenere il 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. Lunghezza massima supportata per il nome è 256 caratteri.

phaseName

string

Nome della fase. 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

Restituisce

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

releaseId

number

releaseEnvId

number

publishContext

string

includeFailureDetails

boolean

releaseToCompare
ReleaseReference

Restituisce

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parametri

releases

ReleaseReference[]

project

string

ID progetto o nome del progetto

Restituisce

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

Restituisce

Promise<WorkItemReference[]>

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, 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, continuationToken?: string): Promise<PagedList<TestRun>>

Parametri

project

string

ID progetto o nome del progetto

minLastUpdatedDate

Date

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

maxLastUpdatedDate

Date

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

state
TestRunState

Stato corrente delle esecuzioni su cui eseguire una query.

planIds

number[]

ID piano delle esecuzioni su cui eseguire una 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 una query.

buildIds

number[]

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

buildDefIds

number[]

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

branchName

string

Nome ramo di origine delle esecuzioni su cui eseguire una 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 una query, elenco delimitato da virgole di ID validi.

releaseEnvIds

number[]

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

releaseEnvDefIds

number[]

ID definizione dell'ambiente di rilascio delle esecuzioni su cui eseguire una 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

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.

Restituisce

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parametri

resultsContext
TestResultsContext
project

string

ID progetto o nome del progetto

workItemIds

number[]

Restituisce

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

buildId

number

ID della compilazione da ottenere

testLogStoreOperationType
TestLogStoreOperationType

Tipo di operazione da eseguire usando l'URI sas

Restituisce

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

Creare un file vuoto per un risultato e ottenere l'URI sas 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 del 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 il cui URI sas del file è necessario

filePath

string

percorso del file all'interno del risultato secondario per il quale è necessario l'URI sas

type
TestLogType

Tipo di file per il download

Restituisce

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

Creare un file vuoto per un'esecuzione e ottenere l'URI sas per il file

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

Parametri

project

string

ID progetto o nome del progetto

runId

number

ID dell'esecuzione per ottenere i dettagli dell'endpoint

testLogStoreOperationType
TestLogStoreOperationType

Tipo di operazione da eseguire usando l'URI sas

filePath

string

percorso del file per creare un file vuoto

type
TestLogType

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

Restituisce

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

Ottenere tutti i dettagli dei gruppi disponibili e per questi gruppi si ottengono 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 del progetto

pipelineId

number

ID pipeline. Equivale all'ID 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.

Restituisce

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary summary

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

Parametri

project

string

ID progetto o nome del progetto

buildId

number

coverageData
CodeCoverageData

Restituisce

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

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

Parametri

updateCustomTestField
CustomTestFieldUpdateDefinition
project

string

ID progetto o nome del progetto

Restituisce

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

Restituisce

updateTestResults(TestCaseResult[], string, number)

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

Parametri

results

TestCaseResult[]

project

string

ID progetto o nome del progetto

runId

number

Restituisce

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 update input TestResultMetaDataUpdateInput

project

string

ID progetto o nome del progetto

testCaseReferenceId

number

Id testCaseReference del risultato del test da aggiornare.

Restituisce

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 del test proprietà MRX e testResultId esistente

project

string

ID progetto o nome del progetto

runId

number

RunId dell'esecuzione del test

Restituisce

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

runId

number

Restituisce

Promise<TestRun>

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

runId

number

RunId dell'esecuzione

Restituisce

Promise<TestTag[]>