TestResultsRestClient class

Référence

Paquet:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends: RestClientBase

Constructeurs

TestResultsRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

addCustomFields(CustomTestFieldDefinition[], string)
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	Ajouter des résultats de test à la session d’exécution de test
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createAnalysis(TestSessionAnalysis[], string, number)	Crée un objet Analyse de session dans le magasin de données TCM pour une session donnée
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	Crée une pièce jointe dans logStore pour l’id de buildId spécifié.
createEnvironment(TestSessionEnvironment[], string)	Crée un objet Environment dans le magasin de données TCM
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	Pour l’ID de session fourni, crée des objets d’environnement, de configuration et de machine dans le magasin de données TCM
createFailureType(TestResultFailureTypeRequestModel, string)	Crée un type d’échec de test
createNotification(TestSessionNotification[], string, number)	Crée un objet Notification dans le magasin de données TCM pour une session donnée
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	Crée une pièce jointe dans logStore pour l’runId spécifié.
createTestSession(TestResultsSession, string)	Crée un objet TestResultsSession dans le magasin de données TCM
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
deleteCustomFieldById(string, number)
deleteFailureType(string, number)	Supprime un type d’échec de test avec failureTypeId spécifié
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)	Supprime la pièce jointe avec le nom de fichier spécifié pour l’runId spécifié à partir du 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 Request : build ID et delta build ID (facultatif)
getCoverageStatusBadge(string, string, string, string)	<p>Obtient l’état de couverture de la dernière build réussie d’une définition, éventuellement étendue à une branche spécifique</p>
getFailureTypes(string)	Retourne la liste des types d’échecs de test.
getFileLevelCodeCoverage(FileCoverageRequest, string)	Obtenir la couverture des fichiers pour le fichier spécifié
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	Récupère les objets De notification TestResultsSession dans le magasin de données TCM
getSimilarTestResults(string, number, number, number, number, String)	Obtient la liste des résultats dont l’échec correspond à celui fourni.
getTestIterationAttachmentContent(string, number, number, number, number)	Retourne une pièce jointe d’itération de test
getTestIterationAttachmentZip(string, number, number, number, number)	Retourne une pièce jointe d’itération de test
getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)	Obtenir la liste des informations de référence sur les pièces jointes de build
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	Obtenir l’URI SAP d’une pièce jointe de build
getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)	Obtenir l’URI SAP d’une pièce jointe de résultats de test
getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)	Obtenir l’URI SAP d’une pièce jointe d’exécution de test
getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)	Obtenir l’URI SAS d’une pièce jointe de test
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	Obtenez un résumé des résultats des tests.
getTestResultAttachmentContent(string, number, number, number)	Retourne une pièce jointe de résultat de test
getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)	Retourne une pièce jointe de résultat de 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)	Obtenir la liste des pièces jointes de résultat de test référence
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)	Obtenez la liste des résultats.
getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)	Obtenir des données TestResultsSettings
getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)	Retourne une pièce jointe d’exécution de test
getTestRunAttachments(string, number)
getTestRunAttachmentZip(string, number, number)	Retourne une pièce jointe d’exécution de test
getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)	Obtenir la liste des références sur les pièces jointes d’exécution de test
getTestRunLogStoreAttachmentContent(string, number, string)	Retourne la pièce jointe avec le nom de fichier spécifié pour l’runId spécifié à partir du LogStore.
getTestRunLogStoreAttachments(string, number)	Retourne une liste de pièces jointes pour l’runId spécifié à partir du LogStore.
getTestRunLogStoreAttachmentZip(string, number, string)	Retourne la pièce jointe avec le nom de fichier spécifié pour l’runId spécifié à partir du LogStore.
getTestRunMessageLogs(string, number)	Obtenir les journaux des messages d’exécution de test
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
getTestRunsBySessionId(string, number)	Récupère les exécutions de test associées à une session
getTestRunStatistics(string, number)	Obtenez des statistiques d’exécution de test, utilisées lorsque nous voulons obtenir un résumé d’une exécution par résultat.
getTestRunSummaryByOutcome(string, number)	Obtenez le résumé de l’exécution des tests, utilisé lorsque nous voulons obtenir le résumé d’une exécution par résultat. L’exécution de test doit être en état terminé.
getTestSession(string, number)	Récupère l’objet de métadonnées TestResultsSession dans le magasin de données TCM
getTestSessionLayout(string, string)	Récupère l’objet TestResultsSession Layout dans le magasin de données TCM
getTestSessionLayoutBySessionId(string, number)	Récupère l’objet TestResultsSession Layout dans le magasin de données TCM
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Retourne une pièce jointe de sous-résultat de test
getTestSubResultAttachments(string, number, number, number)	Retourne des références de pièces jointes pour le sous-résultat de test.
getTestSubResultAttachmentZip(string, number, number, number, number)	Retourne une pièce jointe de sous-résultat de test
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	Obtenir la liste des informations de référence sur les pièces jointes de test
getTestTagsForBuild(string, number)	Obtenez toutes les balises d’une build.
getTestTagsForRelease(string, number, number)	Obtenez toutes les balises dans une version.
getTestTagSummaryForBuild(string, number)	Obtenez toutes les balises d’une build.
getTestTagSummaryForRelease(string, number, number)	Obtenez toutes les balises dans une version.
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Obtenir l’historique d’une méthode de test à l’aide de TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)	Obtenir la liste des détails des métadonnées de résultat de test pour l’id de testcasereferenceId correspondant
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)	Obtenez un résumé des résultats des tests.
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	Query Test Result WorkItems en fonction du filtre
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)	Exécutions de tests de requête basées sur des filtres. Les champs obligatoires sont minLastUpdatedDate et maxLastUpdatedDate.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	Créer et obtenir l’URI sas du conteneur de build
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	Créer un fichier vide pour un résultat et obtenir l’URI Sas du fichier
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	Créer un fichier vide pour une exécution et obtenir un URI Sas pour le fichier
testResultsGroupDetails(string, number, string, string, string, boolean, boolean)	Obtenez tous les détails des groupes disponibles et, pour ces groupes, les résultats ont échoué et abandonnés.
updateCodeCoverageSummary(string, number, CodeCoverageData)	http://(tfsserver) :8080/tfs/DefaultCollection/_apis/test/CodeCoverage ?buildId=10 Request : Json of code coverage summary
updateCustomField(CustomTestFieldUpdateDefinition, string)
updatePipelinesTestSettings(TestResultsUpdateSettings, string)	Mettre à jour les paramètres du projet des résultats des tests
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	Mettre à jour les propriétés des métadonnées de résultat de test
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	Crée des objets TestResultsMRX dans le magasin de données TCM pour les résultats de test existants
updateTestRun(RunUpdateModel, string, number)
updateTestRunTags(TestTagsUpdateModel, string, number)	Mettre à jour les balises d’une exécution, les balises peuvent être ajoutées et supprimées

Détails du constructeur

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

addCustomFields(CustomTestFieldDefinition[], string)

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

Paramètres

newFields: CustomTestFieldDefinition[]

project: string

ID de projet ou nom du projet

Retours

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

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

Paramètres

results: TestCaseResult[]

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Ajouter des résultats de test à la session d’exécution de test

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

Paramètres

results: TestCaseResult[]

project: string

ID de projet ou nom du projet

runId: number

RunId de l’exécution de test

Retours

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

Paramètres

workItemToTestLinks: WorkItemToTestLinks

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemToTestLinks>

createAnalysis(TestSessionAnalysis[], string, number)

Crée un objet Analyse de session dans le magasin de données TCM pour une session donnée

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

Paramètres

analysis: TestSessionAnalysis[]

Détails de l’analyse de session

project: string

ID de projet ou nom du projet

sessionId: number

ID de session à ajouter une notification

Retours

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Crée une pièce jointe dans logStore pour l’id de buildId spécifié.

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

Contient des informations de pièce jointe telles que le flux, le nom de fichier, le commentaire, attachmentType

project: string

ID de projet ou nom du projet

buildId: number

BuildId

Retours

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Crée un objet Environment dans le magasin de données TCM

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

Paramètres

environments: TestSessionEnvironment[]

Objet Environment reçu.

project: string

ID de projet ou nom du projet

Retours

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Pour l’ID de session fourni, crée des objets d’environnement, de configuration et de machine dans le magasin de données TCM

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

Paramètres

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

ID de projet ou nom du projet

sessionId: number

Retours

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Crée un type d’échec de test

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

Paramètres

testResultFailureType: TestResultFailureTypeRequestModel

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

Crée un objet Notification dans le magasin de données TCM pour une session donnée

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

Paramètres

notifications: TestSessionNotification[]

Notification(s) à ajouter pour l’ID de session spécifié

project: string

ID de projet ou nom du projet

sessionId: number

ID de session à ajouter une notification

Retours

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>

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

iterationId: number

actionPath: string

Retours

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

Retours

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

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

Paramètres

testRun: RunCreateModel

project: string

ID de projet ou nom du projet

Retours

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Crée une pièce jointe dans logStore pour l’runId spécifié.

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

Contient des informations de pièce jointe telles que le flux, le nom de fichier, le commentaire, attachmentType

project: string

ID de projet ou nom du projet

runId: number

Test RunId

Retours

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

Crée un objet TestResultsSession dans le magasin de données TCM

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

Paramètres

session: TestResultsSession

Objet de session reçu.

project: string

ID de projet ou nom du projet

Retours

Promise<number>

createTestSettings(TestSettings, string)

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

Paramètres

testSettings: TestSettings

project: string

ID de projet ou nom du projet

Retours

Promise<number>

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

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

testSubResultId: number

Retours

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testExtensionFieldId: number

Retours

Promise<void>

deleteFailureType(string, number)

Supprime un type d’échec de test avec failureTypeId spécifié

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

Paramètres

project: string

ID de projet ou nom du projet

failureTypeId: number

Retours

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testName: string

workItemId: number

Retours

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

Retours

Promise<void>

deleteTestRun(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<void>

deleteTestRunAttachment(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

attachmentId: number

Retours

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Supprime la pièce jointe avec le nom de fichier spécifié pour l’runId spécifié à partir du LogStore.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Test RunId

filename: string

Nom de fichier de pièce jointe

Retours

Promise<void>

deleteTestSettings(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testSettingsId: number

Retours

Promise<void>

fetchSourceCodeCoverageReport(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

Retours

Promise<SourceViewBuildCoverage[]>

getBugsLinkedToTestResult(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

Retours

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

flags: number

Retours

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver) :8080/tfs/DefaultCollection/_apis/test/CodeCoverage ?buildId=10&deltaBuildId=9 Request : build ID et delta build ID (facultatif)

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

deltaBuildId: number

Retours

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

<p>Obtient l’état de couverture de la dernière build réussie d’une définition, éventuellement étendue à une branche spécifique</p>

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

Paramètres

project: string

ID de projet ou nom du projet

definition: string

ID ou nom de la définition.

branchName: string

Nom de la branche.

label: string

Chaîne pour remplacer le texte par défaut sur le côté gauche du badge.

Retours

Promise<string>

getFailureTypes(string)

Retourne la liste des types d’échecs de test.

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

Obtenir la couverture des fichiers pour le fichier spécifié

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

Paramètres

fileCoverageRequest: FileCoverageRequest

Détails du fichier avec contexte d’itération de demande de tirage

project: string

ID de projet ou nom du projet

Retours

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

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

Paramètres

project: string

ID de projet ou nom du projet

buildDefinitionId: number

minBuildCreatedDate: Date

Retours

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestCaseResult[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Retours

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

Récupère les objets De notification TestResultsSession dans le magasin de données TCM

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

Paramètres

project: string

ID de projet ou nom du projet

sessionId: number

ID de la session TestResults pour laquelle obtenir des notifications.

Retours

Promise<TestSessionNotification[]>

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

Obtient la liste des résultats dont l’échec correspond à celui fourni.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test

testResultId: number

ID du résultat du test à l’intérieur d’une exécution de test

testSubResultId: number

ID de sous-résultat à l’intérieur d’un résultat de test

top: number

Nombre maximal de résultats à retourner

continuationToken: String

En-tête pour passer le continuationToken

Retours

Promise<TestCaseResult[]>

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

Retourne une pièce jointe d’itération de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Retours

Promise<ArrayBuffer>

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

Retourne une pièce jointe d’itération de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Retours

Promise<ArrayBuffer>

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

Obtenir la liste des informations de référence sur les pièces jointes de build

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

ID de la build à obtenir

type: TestLogType

type de la pièce jointe à obtenir

directoryPath: string

chemin d’accès au répertoire pour lequel les pièces jointes sont nécessaires

fileNamePrefix: string

préfixe de nom de fichier pour filtrer la liste des pièces jointes

fetchMetaData: boolean

La valeur par défaut est false, définie si les métadonnées sont nécessaires

top: number

Nombre de pièces jointes de test référencées pour retourner

continuationToken: String

En-tête pour passer le continuationToken

Retours

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Obtenir l’URI SAP d’une pièce jointe de build

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

Paramètres

project: string

ID de projet ou nom du projet

build: number

ID de la build à obtenir

type: TestLogType

type du fichier

filePath: string

filePath pour lequel l’URI sas est nécessaire

Retours

Promise<TestLogStoreEndpointDetails>

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

Obtenir l’URI SAP d’une pièce jointe de résultats de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test qui contient le résultat

resultId: number

ID du résultat du test dont les fichiers doivent être téléchargés

type: TestLogType

type du fichier

filePath: string

filePath pour lequel l’URI sas est nécessaire

Retours

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Obtenir l’URI SAP d’une pièce jointe d’exécution de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test dont le fichier doit être téléchargé

type: TestLogType

type du fichier

filePath: string

filePath pour lequel l’URI sas est nécessaire

Retours

Promise<TestLogStoreEndpointDetails>

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

Obtenir l’URI SAS d’une pièce jointe de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test qui contient le résultat

resultId: number

ID du résultat du test qui contient le sous-résultat

subResultId: number

ID du sous-résultat de test dont l’URI sas de fichier est nécessaire

type: TestLogType

type du fichier

filePath: string

filePath pour lequel l’URI sas est nécessaire

Retours

Promise<TestLogStoreEndpointDetails>

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

Obtenez un résumé des résultats des tests.

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

Paramètres

project: string

ID de projet ou nom du projet

pipelineId: number

ID de pipeline. Il s’agit de l’ID de build.

stageName: string

Nom de l’étape. La longueur maximale prise en charge pour le nom est de 256 caractères.

phaseName: string

Nom de la phase. La longueur maximale prise en charge pour le nom est de 256 caractères.

jobName: string

La matrice dans YAML génère des copies d’un travail avec différentes entrées dans la matrice. JobName est le nom de ces entrées. La longueur maximale prise en charge pour le nom est de 256 caractères.

metricNames: Metrics[]

groupByNode: boolean

Résumé du groupe pour chaque nœud de l’hérarchie pipleine

Retours

Promise<PipelineTestMetrics>

getTestResultAttachmentContent(string, number, number, number)

Retourne une pièce jointe de résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

Retours

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

Retours

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Retourne une pièce jointe de résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

Retours

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testResultId: number

detailsToInclude: ResultDetails

Retours

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>

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Retours

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>

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Retours

Promise<TestResultsDetails>

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

Obtenir la liste des pièces jointes de résultat de test référence

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test qui contient le résultat

resultId: number

ID du résultat du test

type: TestLogType

type de pièces jointes à obtenir

directoryPath: string

chemin d’accès de répertoire des pièces jointes à obtenir

fileNamePrefix: string

préfixe de nom de fichier pour filtrer la liste des pièces jointes

fetchMetaData: boolean

La valeur par défaut est false, définie si les métadonnées sont nécessaires

top: number

Engourdissement de la référence des pièces jointes pour retourner

continuationToken: String

En-tête pour passer le continuationToken

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Retours

Promise<PagedList<ShallowTestCaseResult>>

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

Obtenez la liste des résultats.

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

Paramètres

project: string

ID de projet ou nom du projet

pipelineId: number

ID de pipeline. Il s’agit de l’ID de build.

stageName: string

Nom de l’étape. La longueur maximale prise en charge pour le nom est de 256 caractères.

phaseName: string

Nom de la phase. La longueur maximale prise en charge pour le nom est de 256 caractères.

jobName: string

outcomes: TestOutcome[]

Liste des résultats

top: number

Nombre maximal de résultats à retourner

continuationToken: String

En-tête pour passer le continuationToken

Retours

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

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

Paramètres

query: TestResultsQuery

project: string

ID de projet ou nom du projet

Retours

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

Paramètres

queryModel: QueryModel

project: string

ID de projet ou nom du projet

includeResultDetails: boolean

includeIterationDetails: boolean

skip: number

top: number

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Retours

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsSettings(string, TestResultsSettingsType)

Obtenir des données TestResultsSettings

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

Paramètres

project: string

ID de projet ou nom du projet

settingsType: TestResultsSettingsType

Retours

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

Retours

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

Retourne une pièce jointe d’exécution de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

attachmentId: number

Retours

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Retourne une pièce jointe d’exécution de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

attachmentId: number

Retours

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

includeDetails: boolean

includeTags: boolean

Retours

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

flags: number

Retours

Promise<TestRunCoverage[]>

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

Obtenir la liste des références sur les pièces jointes d’exécution de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test

type: TestLogType

type des pièces jointes à obtenir

directoryPath: string

chemin d’accès au répertoire pour lequel les pièces jointes sont nécessaires

fileNamePrefix: string

préfixe de nom de fichier pour filtrer la liste des pièces jointes

fetchMetaData: boolean

La valeur par défaut est false, définie si les métadonnées sont nécessaires

top: number

Nombre de pièces jointes de référence à retourner

continuationToken: String

En-tête pour passer le continuationToken

Retours

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Retourne la pièce jointe avec le nom de fichier spécifié pour l’runId spécifié à partir du LogStore.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Test RunId

filename: string

Nom de fichier de pièce jointe

Retours

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Retourne une liste de pièces jointes pour l’runId spécifié à partir du LogStore.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Test RunId

Retours

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

Retourne la pièce jointe avec le nom de fichier spécifié pour l’runId spécifié à partir du LogStore.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

Test RunId

filename: string

Nom de fichier de pièce jointe

Retours

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

Obtenir les journaux des messages d’exécution de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à obtenir.

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

buildUri: string

owner: string

tmiRunId: string

planId: number

includeRunDetails: boolean

automated: boolean

skip: number

top: number

Retours

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

Récupère les exécutions de test associées à une session

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

Paramètres

project: string

ID de projet ou nom du projet

sessionId: number

ID de la session TestResults pour laquelle obtenir les exécutions de test.

Retours

Promise<number[]>

getTestRunStatistics(string, number)

Obtenez des statistiques d’exécution de test, utilisées lorsque nous voulons obtenir un résumé d’une exécution par résultat.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à obtenir.

Retours

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Obtenez le résumé de l’exécution des tests, utilisé lorsque nous voulons obtenir le résumé d’une exécution par résultat. L’exécution de test doit être en état terminé.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à obtenir.

Retours

Promise<TestRunStatistic>

getTestSession(string, number)

Récupère l’objet de métadonnées TestResultsSession dans le magasin de données TCM

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

Retours

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Récupère l’objet TestResultsSession Layout dans le magasin de données TCM

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

Paramètres

project: string

ID de projet ou nom du projet

sessionId: string

Retours

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Récupère l’objet TestResultsSession Layout dans le magasin de données TCM

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

Paramètres

project: string

ID de projet ou nom du projet

sessionId: number

Récupérer l’objet de session.

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Retours

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testSettingsId: number

Retours

Promise<TestSettings>

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

Retourne une pièce jointe de sous-résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Retours

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Retourne des références de pièces jointes pour le sous-résultat de test.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

testSubResultId: number

Retours

Promise<TestAttachment[]>

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

Retourne une pièce jointe de sous-résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Retours

Promise<ArrayBuffer>

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

Obtenir la liste des informations de référence sur les pièces jointes de 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>>

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test qui contient les résultats

resultId: number

ID du résultat du test qui contient le sous-résultat

subResultId: number

ID du sous-résultat de test

type: TestLogType

type des pièces jointes à obtenir

directoryPath: string

chemin d’accès du répertoire de la pièce jointe à obtenir

fileNamePrefix: string

préfixe de nom de fichier pour filtrer la liste des pièces jointes

fetchMetaData: boolean

La valeur par défaut est false, définie si les métadonnées sont nécessaires

top: number

Nombre de pièces jointes de référence à retourner

continuationToken: String

En-tête pour passer le continuationToken

Retours

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Obtenez toutes les balises d’une build.

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

Build ID

Retours

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Obtenez toutes les balises dans une version.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de mise en production

releaseEnvId: number

ID d’environnement de mise en production

Retours

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Obtenez toutes les balises d’une build.

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

Build ID

Retours

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Obtenez toutes les balises dans une version.

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

ID de mise en production

releaseEnvId: number

ID d’environnement de mise en production

Retours

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

Paramètres

document: TestResultDocument

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

Paramètres

project: string

ID de projet ou nom du projet

scopeFilter: CustomTestFieldScope

Retours

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Paramètres

filter: TestResultTrendFilter

project: string

ID de projet ou nom du projet

Retours

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Paramètres

filter: TestResultTrendFilter

project: string

ID de projet ou nom du projet

Retours

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Obtenir l’historique d’une méthode de test à l’aide de TestHistoryQuery

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

Paramètres

filter: TestHistoryQuery

TestHistoryQuery pour obtenir l’historique

project: string

ID de projet ou nom du projet

Retours

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Paramètres

project: string

ID de projet ou nom du projet

testName: string

Retours

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

Paramètres

filter: ResultsFilter

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

Obtenir la liste des détails des métadonnées de résultat de test pour l’id de testcasereferenceId correspondant

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

Paramètres

testCaseReferenceIds: string[]

ID TestCaseReference du résultat de test à interroger, liste séparée par des virgules des ID valides (limite non. des ID 200).

project: string

ID de projet ou nom du projet

detailsToInclude: ResultMetaDataDetails

Détails à inclure avec les métadonnées des résultats de test. La valeur par défaut est None. D’autres valeurs sont FlakyIdentifiers.

Retours

Promise<TestResultMetaData[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Retours

Promise<TestResultSummary>

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

Obtenez un résumé des résultats des tests.

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

Paramètres

project: string

ID de projet ou nom du projet

pipelineId: number

ID de pipeline. Il s’agit de l’ID de build.

stageName: string

Nom de l’étape. La longueur maximale prise en charge pour le nom est de 256 caractères.

phaseName: string

Nom de la phase. La longueur maximale prise en charge pour le nom est de 256 caractères.

jobName: string

includeFailureDetails: boolean

Si la valeur true retourne des insights d’échec

Retours

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>

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Retours

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Paramètres

releases: ReleaseReference[]

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultSummary[]>

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

Query Test Result WorkItems en fonction du filtre

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

Paramètres

project: string

ID de projet ou nom du projet

workItemCategory: string

peut prendre des valeurs Microsoft.BugCategory ou all(pour obtenir tous les éléments de travail)

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Retours

Promise<WorkItemReference[]>

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

Exécutions de tests de requête basées sur des filtres. Les champs obligatoires sont minLastUpdatedDate et 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>>

Paramètres

project: string

ID de projet ou nom du projet

minLastUpdatedDate: Date

Date minimale de dernière modification de l’exécution à interroger (obligatoire).

maxLastUpdatedDate: Date

Date maximale de dernière modification de l’exécution à interroger (obligatoire, la différence entre min et la date maximale peut être maximale de 7 jours).

state: TestRunState

État actuel des exécutions à interroger.

planIds: number[]

ID de plan des exécutions à interroger, liste séparée par des virgules d’ID valides.

isAutomated: boolean

Type d’automatisation des exécutions à interroger.

publishContext: TestRunPublishContext

PublishContext des exécutions à interroger.

buildIds: number[]

ID de build des exécutions à interroger, liste séparée par des virgules des ID valides.

buildDefIds: number[]

ID de définition de build des exécutions à interroger, liste séparée par des virgules d’ID valides.

branchName: string

Nom de la branche source des exécutions à interroger.

releaseIds: number[]

ID de mise en production des exécutions à interroger, liste séparée par des virgules d’ID valides.

releaseDefIds: number[]

ID de définition de mise en production des exécutions à interroger, liste séparée par des virgules d’ID valides.

releaseEnvIds: number[]

Ids d’environnement de mise en production des exécutions à interroger, liste séparée par des virgules d’ID valides.

releaseEnvDefIds: number[]

Id de définition d’environnement de mise en production des exécutions à interroger, liste séparée par des virgules d’ID valides.

runTitle: string

Titre d’exécution des exécutions à interroger.

top: number

Nombre d’exécutions à interroger. La limite est de 100

continuationToken: string

continuationToken reçu du lot précédent ou null pour le premier lot. Il n’est pas censé être créé (ou modifié, s’il est reçu du dernier lot) par l’utilisateur.

Retours

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Paramètres

resultsContext: TestResultsContext

project: string

ID de projet ou nom du projet

workItemIds: number[]

Retours

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Créer et obtenir l’URI sas du conteneur de build

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

ID de la build à obtenir

testLogStoreOperationType: TestLogStoreOperationType

Type d’opération à effectuer à l’aide de l’URI sas

Retours

Promise<TestLogStoreEndpointDetails>

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

Créer un fichier vide pour un résultat et obtenir l’URI Sas du fichier

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution de test qui contient le résultat

resultId: number

ID des résultats de test qui contiennent un sous-résultat

subResultId: number

ID du sous-résultat du test dont l’URI sas de fichier est nécessaire

filePath: string

chemin d’accès au fichier à l’intérieur du sous-résultat pour lequel l’URI sas est nécessaire

type: TestLogType

Type du fichier à télécharger

Retours

Promise<TestLogStoreEndpointDetails>

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

Créer un fichier vide pour une exécution et obtenir un URI Sas pour le fichier

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution pour obtenir les détails du point de terminaison

testLogStoreOperationType: TestLogStoreOperationType

Type d’opération à effectuer à l’aide de l’URI sas

filePath: string

chemin d’accès au fichier pour créer un fichier vide

type: TestLogType

La valeur par défaut est GeneralAttachment, type de fichier vide à créer

Retours

Promise<TestLogStoreEndpointDetails>

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

Obtenez tous les détails des groupes disponibles et, pour ces groupes, les résultats ont échoué et abandonnés.

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

Paramètres

project: string

ID de projet ou nom du projet

pipelineId: number

ID de pipeline. Il s’agit de l’ID de build.

stageName: string

Nom de l’étape. La longueur maximale prise en charge pour le nom est de 256 caractères.

phaseName: string

Nom de la phase. La longueur maximale prise en charge pour le nom est de 256 caractères.

jobName: string

shouldIncludeFailedAndAbortedResults: boolean

Si la valeur est true, elle retourne les ID d’échec et les résultats abandonnés pour chaque groupe de tests

queryGroupSummaryForInProgress: boolean

Si la valeur est true, elle calcule également le résumé des exécutions InProgress.

Retours

Promise<TestResultsDetails>

updateCodeCoverageSummary(string, number, CodeCoverageData)

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

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

coverageData: CodeCoverageData

Retours

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

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

Paramètres

updateCustomTestField: CustomTestFieldUpdateDefinition

project: string

ID de projet ou nom du projet

Retours

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

Mettre à jour les paramètres du projet des résultats des tests

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

Paramètres

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

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

Paramètres

results: TestCaseResult[]

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Mettre à jour les propriétés des métadonnées de résultat de test

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

Paramètres

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData update input TestResultMetaDataUpdateInput

project: string

ID de projet ou nom du projet

testCaseReferenceId: number

ID TestCaseReference du résultat de test à mettre à jour.

Retours

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Crée des objets TestResultsMRX dans le magasin de données TCM pour les résultats de test existants

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

Paramètres

results: TestCaseResult[]

Objet Results avec uniquement les propriétés MRX des résultats de test et testResultId existants

project: string

ID de projet ou nom du projet

runId: number

RunId de l’exécution de test

Retours

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

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

Paramètres

runUpdateModel: RunUpdateModel

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestRun>

updateTestRunTags(TestTagsUpdateModel, string, number)

Mettre à jour les balises d’une exécution, les balises peuvent être ajoutées et supprimées

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

Paramètres

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

ID de projet ou nom du projet

runId: number

RunId de l’exécution

Retours

Promise<TestTag[]>

Partager via

TestResultsRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

TestResultsRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

addCustomFields(CustomTestFieldDefinition[], string)

Paramètres

Retours

addTestResultsToTestRun(TestCaseResult[], string, number)

Paramètres

Retours

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Paramètres

Retours

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Paramètres

Retours

createAnalysis(TestSessionAnalysis[], string, number)

Paramètres

Retours

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Paramètres

Retours

createEnvironment(TestSessionEnvironment[], string)

Paramètres

Retours

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Paramètres

Retours

createFailureType(TestResultFailureTypeRequestModel, string)

Paramètres

Retours

createNotification(TestSessionNotification[], string, number)

Paramètres

Retours

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

Paramètres

Retours

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Paramètres

Retours

createTestRun(RunCreateModel, string)

Paramètres

Retours

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Paramètres

Retours

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Paramètres

Retours

createTestSession(TestResultsSession, string)

Paramètres

Retours

createTestSettings(TestSettings, string)

Paramètres

Retours

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

Paramètres

Retours

deleteCustomFieldById(string, number)

Paramètres

Retours

deleteFailureType(string, number)

Paramètres

Retours

deleteTestMethodToWorkItemLink(string, string, number)

Paramètres

Retours

deleteTestResultAttachment(string, number, number, number)

Paramètres

Retours

deleteTestRun(string, number)

Paramètres