TestResultsRestClient class

Referenz

Paket:: azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends: RestClientBase

Konstruktoren

TestResultsRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addCustomFields(CustomTestFieldDefinition[], string)
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	Hinzufügen von Testergebnissen zur Testausführungssitzung
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createAnalysis(TestSessionAnalysis[], string, number)	Erstellt ein Session Analysis -Objekt im TCM-Datenspeicher für eine bestimmte Sitzung
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	Erstellt eine Anlage im LogStore für die angegebene buildId.
createEnvironment(TestSessionEnvironment[], string)	Erstellt environment-Objekt im TCM-Datenspeicher
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	Erstellt für die bereitgestellte sessionId Umgebungs-, Konfigurations- und Computerobjekte im TCM-Datenspeicher.
createFailureType(TestResultFailureTypeRequestModel, string)	Erstellt einen neuen Testfehlertyp.
createNotification(TestSessionNotification[], string, number)	Erstellt ein Notification-Objekt im TCM-Datenspeicher für eine bestimmte Sitzung.
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	Erstellt eine Anlage im LogStore für die angegebene RunId.
createTestSession(TestResultsSession, string)	Erstellt das TestResultsSession-Objekt im TCM-Datenspeicher.
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
deleteCustomFieldById(string, number)
deleteFailureType(string, number)	Löscht einen Testfehlertyp mit der angegebenen failureTypeId
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)	Löscht die Anlage mit dem angegebenen Dateinamen für die angegebene runId aus dem 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 Anforderung: Build-ID und Delta-Build-ID (optional)
getCoverageStatusBadge(string, string, string, string)	<p>Ruft den Abdeckungsstatus für den letzten erfolgreichen Build einer Definition ab, optional auf eine bestimmte Verzweigung</p>
getFailureTypes(string)	Gibt die Liste der Testfehlertypen zurück.
getFileLevelCodeCoverage(FileCoverageRequest, string)	Abrufen der Dateiabdeckung für die angegebene Datei
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	Ruft TestResultsSession Notification-Objekte im TCM-Datenspeicher ab.
getSimilarTestResults(string, number, number, number, number, String)	Ruft die Liste der Ergebnisse ab, deren Fehler mit dem bereitgestellten übereinstimmen.
getTestIterationAttachmentContent(string, number, number, number, number)	Gibt eine Test iterationsanlage zurück.
getTestIterationAttachmentZip(string, number, number, number, number)	Gibt eine Test iterationsanlage zurück.
getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)	Abrufen einer Liste der Referenz zu Buildanlagen
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	Abrufen des SAS-URI einer Buildanlage
getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)	Abrufen des SAS-URI einer Testergebnisanlage
getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)	Abrufen des SAS-URI einer Testausführungsanlage
getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)	Abrufen des SAS-URI einer Test-Subresults-Anlage
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	Abrufen einer Zusammenfassung der Testergebnisse.
getTestResultAttachmentContent(string, number, number, number)	Gibt eine Testergebnisanlage zurück.
getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)	Gibt eine Testergebnisanlage zurück.
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)	Liste der Referenz zu Testergebnisanlagen abrufen
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)	Dient zum Abrufen einer Liste von Ergebnissen.
getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)	Abrufen von TestResultsSettings-Daten
getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)	Gibt eine Testausführungsanlage zurück.
getTestRunAttachments(string, number)
getTestRunAttachmentZip(string, number, number)	Gibt eine Testausführungsanlage zurück.
getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)	Abrufen einer Liste der Referenz zu Testausführungsanlagen
getTestRunLogStoreAttachmentContent(string, number, string)	Gibt die Anlage mit dem angegebenen Dateinamen für die angegebene runId aus dem LogStore zurück.
getTestRunLogStoreAttachments(string, number)	Gibt eine Liste von Anlagen für die angegebene RunId aus dem LogStore zurück.
getTestRunLogStoreAttachmentZip(string, number, string)	Gibt die Anlage mit dem angegebenen Dateinamen für die angegebene runId aus dem LogStore zurück.
getTestRunMessageLogs(string, number)	Abrufen von Testausführungsnachrichtenprotokollen
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
getTestRunsBySessionId(string, number)	Ruft Testausführungen ab, die einer Sitzung zugeordnet sind
getTestRunStatistics(string, number)	Get test run statistics , used when we want to get summary of a run by outcome.
getTestRunSummaryByOutcome(string, number)	Abrufen der Testausführungszusammenfassung, die verwendet wird, wenn eine Zusammenfassung einer Ausführung nach Ergebnis abgerufen werden soll. Der Testlauf sollte im Status "Abgeschlossen" sein.
getTestSession(string, number)	Ruft das TestResultsSession-Metadatenobjekt im TCM-Datenspeicher ab.
getTestSessionLayout(string, string)	Ruft das TestResultsSession Layout-Objekt im TCM-Datenspeicher ab.
getTestSessionLayoutBySessionId(string, number)	Ruft das TestResultsSession Layout-Objekt im TCM-Datenspeicher ab.
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Gibt eine Testunterergebnisanlage zurück.
getTestSubResultAttachments(string, number, number, number)	Gibt Anlagenverweise für das Testunterergebnis zurück.
getTestSubResultAttachmentZip(string, number, number, number, number)	Gibt eine Testunterergebnisanlage zurück.
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	Abrufen einer Liste der Referenz zu Test-Subresult-Anlagen
getTestTagsForBuild(string, number)	Rufen Sie alle Tags in einem Build ab.
getTestTagsForRelease(string, number, number)	Rufen Sie alle Tags in einer Version ab.
getTestTagSummaryForBuild(string, number)	Rufen Sie alle Tags in einem Build ab.
getTestTagSummaryForRelease(string, number, number)	Rufen Sie alle Tags in einer Version ab.
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Abrufen des Verlaufs einer Testmethode mithilfe von TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)	Abrufen der Liste der Testergebnismetadatendetails für die entsprechende TestcasereferenceId
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)	Abrufen einer Zusammenfassung der Testergebnisse.
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	Abfragetestergebnis-WorkItems basierend auf dem Filter
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)	Abfragetest wird basierend auf Filtern ausgeführt. Pflichtfelder sind "minLastUpdatedDate" und "maxLastUpdatedDate".
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	Erstellen und Abrufen von SAS-URI des Buildcontainers
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	Erstellen einer leeren Datei für ein Ergebnis und Abrufen von Sas-URI für die Datei
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	Erstellen einer leeren Datei für eine Ausführung und Abrufen von Sas-URI für die Datei
testResultsGroupDetails(string, number, string, string, string, boolean, boolean)	Rufen Sie alle verfügbaren Gruppendetails ab, und für diese Gruppen werden fehler- und abgebrochene Ergebnisse angezeigt.
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)	Aktualisieren der Projekteinstellungen von Testergebnissen
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	Aktualisieren von Eigenschaften von Testergebnismetadaten
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	Erstellt TestResultsMRX-Objekte im TCM-Datenspeicher für vorhandene Testergebnisse
updateTestRun(RunUpdateModel, string, number)
updateTestRunTags(TestTagsUpdateModel, string, number)	Aktualisieren von Tags einer Ausführung, Tags können hinzugefügt und gelöscht werden

Details zum Konstruktor

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addCustomFields(CustomTestFieldDefinition[], string)

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

Parameter

newFields: CustomTestFieldDefinition[]

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

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

Parameter

results: TestCaseResult[]

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Hinzufügen von Testergebnissen zur Testausführungssitzung

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

Parameter

results: TestCaseResult[]

project: string

Projekt-ID oder Projektname

runId: number

RunId des Testlaufs

Gibt zurück

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

Parameter

workItemToTestLinks: WorkItemToTestLinks

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<WorkItemToTestLinks>

createAnalysis(TestSessionAnalysis[], string, number)

Erstellt ein Session Analysis -Objekt im TCM-Datenspeicher für eine bestimmte Sitzung

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

Parameter

analysis: TestSessionAnalysis[]

Sitzungsanalysedetails

project: string

Projekt-ID oder Projektname

sessionId: number

ID der Sitzung zum Hinzufügen von Benachrichtigungen

Gibt zurück

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Erstellt eine Anlage im LogStore für die angegebene buildId.

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

Parameter

attachmentRequestModel: TestAttachmentRequestModel

Enthält Anlageninformationen wie Stream, Dateiname, Kommentar, attachmentType

project: string

Projekt-ID oder Projektname

buildId: number

BuildId

Gibt zurück

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Erstellt environment-Objekt im TCM-Datenspeicher

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

Parameter

environments: TestSessionEnvironment[]

Empfangenes Umgebungsobjekt.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Erstellt für die bereitgestellte sessionId Umgebungs-, Konfigurations- und Computerobjekte im TCM-Datenspeicher.

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

Parameter

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

Projekt-ID oder Projektname

sessionId: number

Gibt zurück

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Erstellt einen neuen Testfehlertyp.

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

Parameter

testResultFailureType: TestResultFailureTypeRequestModel

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

Erstellt ein Notification-Objekt im TCM-Datenspeicher für eine bestimmte Sitzung.

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

Parameter

notifications: TestSessionNotification[]

Benachrichtigungen, die für die angegebene sessionId hinzugefügt werden sollen

project: string

Projekt-ID oder Projektname

sessionId: number

ID der Sitzung zum Hinzufügen von Benachrichtigungen

Gibt zurück

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>

Parameter

attachmentRequestModel: TestAttachmentRequestModel

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

iterationId: number

actionPath: string

Gibt zurück

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

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

Parameter

attachmentRequestModel: TestAttachmentRequestModel

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

Gibt zurück

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

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

Parameter

testRun: RunCreateModel

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

Parameter

attachmentRequestModel: TestAttachmentRequestModel

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Erstellt eine Anlage im LogStore für die angegebene RunId.

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

Parameter

attachmentRequestModel: TestAttachmentRequestModel

Enthält Anlageninformationen wie Stream, Dateiname, Kommentar, attachmentType

project: string

Projekt-ID oder Projektname

runId: number

Test RunId

Gibt zurück

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

Erstellt das TestResultsSession-Objekt im TCM-Datenspeicher.

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

Parameter

session: TestResultsSession

Empfangenes Sitzungsobjekt.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<number>

createTestSettings(TestSettings, string)

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

Parameter

testSettings: TestSettings

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<number>

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

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

Parameter

attachmentRequestModel: TestAttachmentRequestModel

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

testSubResultId: number

Gibt zurück

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

testExtensionFieldId: number

Gibt zurück

Promise<void>

deleteFailureType(string, number)

Löscht einen Testfehlertyp mit der angegebenen failureTypeId

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

Parameter

project: string

Projekt-ID oder Projektname

failureTypeId: number

Gibt zurück

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

testName: string

workItemId: number

Gibt zurück

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

Gibt zurück

Promise<void>

deleteTestRun(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<void>

deleteTestRunAttachment(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

attachmentId: number

Gibt zurück

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Löscht die Anlage mit dem angegebenen Dateinamen für die angegebene runId aus dem LogStore.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Test RunId

filename: string

Dateiname der Anlage

Gibt zurück

Promise<void>

deleteTestSettings(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

testSettingsId: number

Gibt zurück

Promise<void>

fetchSourceCodeCoverageReport(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Gibt zurück

Promise<SourceViewBuildCoverage[]>

getBugsLinkedToTestResult(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

Gibt zurück

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

flags: number

Gibt zurück

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Anforderung: Build-ID und Delta-Build-ID (optional)

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

deltaBuildId: number

Gibt zurück

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

<p>Ruft den Abdeckungsstatus für den letzten erfolgreichen Build einer Definition ab, optional auf eine bestimmte Verzweigung</p>

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

Parameter

project: string

Projekt-ID oder Projektname

definition: string

Die ID oder der Name der Definition.

branchName: string

Der Verzweigungsname.

label: string

Die Zeichenfolge, die den Standardtext auf der linken Seite des Badges ersetzt.

Gibt zurück

Promise<string>

getFailureTypes(string)

Gibt die Liste der Testfehlertypen zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

Abrufen der Dateiabdeckung für die angegebene Datei

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

Parameter

fileCoverageRequest: FileCoverageRequest

Dateidetails mit Pullanforderungs-Iterationskontext

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

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

Parameter

project: string

Projekt-ID oder Projektname

buildDefinitionId: number

minBuildCreatedDate: Date

Gibt zurück

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestCaseResult[]>

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

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Gibt zurück

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

Ruft TestResultsSession Notification-Objekte im TCM-Datenspeicher ab.

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

Parameter

project: string

Projekt-ID oder Projektname

sessionId: number

ID der TestResults-Sitzung zum Abrufen von Benachrichtigungen für.

Gibt zurück

Promise<TestSessionNotification[]>

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

Ruft die Liste der Ergebnisse ab, deren Fehler mit dem bereitgestellten übereinstimmen.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung

testResultId: number

ID des Testergebnisses innerhalb einer Testausführung

testSubResultId: number

ID des Teilergebnisses innerhalb eines Testergebnisses

top: number

Maximale Anzahl der zurückzugebenden Ergebnisse

continuationToken: String

Header zum Übergeben des Fortsetzungstokens

Gibt zurück

Promise<TestCaseResult[]>

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

Gibt eine Test iterationsanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Gibt zurück

Promise<ArrayBuffer>

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

Gibt eine Test iterationsanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Gibt zurück

Promise<ArrayBuffer>

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

Abrufen einer Liste der Referenz zu Buildanlagen

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

ID des abzurufenden Builds

type: TestLogType

Typ der abzurufenden Anlage

directoryPath: string

Verzeichnispfad, für den Anlagen erforderlich sind

fileNamePrefix: string

Dateinamepräfix zum Filtern der Liste der Anlagen

fetchMetaData: boolean

Der Standardwert ist "false", wenn Metadaten erforderlich sind.

top: number

Anzahl der zurückzugebenden Testanlagen

continuationToken: String

Header zum Übergeben des Fortsetzungstokens

Gibt zurück

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Abrufen des SAS-URI einer Buildanlage

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

Parameter

project: string

Projekt-ID oder Projektname

build: number

ID des abzurufenden Builds

type: TestLogType

Dateityp

filePath: string

filePath, für den SAS-URI erforderlich ist

Gibt zurück

Promise<TestLogStoreEndpointDetails>

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

Abrufen des SAS-URI einer Testergebnisanlage

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung, die das Ergebnis enthält

resultId: number

ID des Testergebnisses, dessen Dateien heruntergeladen werden müssen

type: TestLogType

Dateityp

filePath: string

filePath, für den SAS-URI erforderlich ist

Gibt zurück

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Abrufen des SAS-URI einer Testausführungsanlage

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung, deren Datei heruntergeladen werden muss

type: TestLogType

Dateityp

filePath: string

filePath, für den SAS-URI erforderlich ist

Gibt zurück

Promise<TestLogStoreEndpointDetails>

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

Abrufen des SAS-URI einer Test-Subresults-Anlage

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung, die das Ergebnis enthält

resultId: number

ID des Testergebnisses, das Untergeordnetes Ergebnis enthält

subResultId: number

ID des Testunterergebnisses, dessen Datei sas-URI erforderlich ist

type: TestLogType

Dateityp

filePath: string

filePath, für den SAS-URI erforderlich ist

Gibt zurück

Promise<TestLogStoreEndpointDetails>

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

Abrufen einer Zusammenfassung der Testergebnisse.

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

Parameter

project: string

Projekt-ID oder Projektname

pipelineId: number

Pipeline-ID. Dies ist identisch mit der Build-ID.

stageName: string

Name der Stufe. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

phaseName: string

Name der Phase. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

jobName: string

Durch die Matrixerstellung in YAML werden Kopien eines Auftrags mit unterschiedlichen Eingaben in der Matrix generiert. JobName ist der Name dieser Eingabe. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

metricNames: Metrics[]

groupByNode: boolean

Gruppenzusammenfassung für jeden Knoten der Pipleine-Erbe

Gibt zurück

Promise<PipelineTestMetrics>

getTestResultAttachmentContent(string, number, number, number)

Gibt eine Testergebnisanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

Gibt zurück

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

Gibt zurück

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Gibt eine Testergebnisanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

Gibt zurück

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testResultId: number

detailsToInclude: ResultDetails

Gibt zurück

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>

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Gibt zurück

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>

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Gibt zurück

Promise<TestResultsDetails>

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

Liste der Referenz zu Testergebnisanlagen abrufen

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung, die das Ergebnis enthält

resultId: number

ID des Testergebnisses

type: TestLogType

Typ der abzurufenden Anlagen

directoryPath: string

Verzeichnispfad der abzurufenden Anlagen

fileNamePrefix: string

Dateinamepräfix zum Filtern der Liste der Anlagen

fetchMetaData: boolean

Der Standardwert ist "false", wenn Metadaten erforderlich sind.

top: number

Anzahl der zurückzugebenden Anlagen

continuationToken: String

Header zum Übergeben des Fortsetzungstokens

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Gibt zurück

Promise<PagedList<ShallowTestCaseResult>>

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

Dient zum Abrufen einer Liste von Ergebnissen.

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

Parameter

project: string

Projekt-ID oder Projektname

pipelineId: number

Pipeline-ID. Dies ist identisch mit der Build-ID.

stageName: string

Name der Stufe. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

phaseName: string

Name der Phase. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

jobName: string

outcomes: TestOutcome[]

Ergebnisliste der Ergebnisse

top: number

Maximale Anzahl der zurückzugebenden Ergebnisse

continuationToken: String

Header zum Übergeben des Fortsetzungstokens

Gibt zurück

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

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

Parameter

query: TestResultsQuery

project: string

Projekt-ID oder Projektname

Gibt zurück

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

Parameter

queryModel: QueryModel

project: string

Projekt-ID oder Projektname

includeResultDetails: boolean

includeIterationDetails: boolean

skip: number

top: number

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Gibt zurück

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsSettings(string, TestResultsSettingsType)

Abrufen von TestResultsSettings-Daten

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

Parameter

project: string

Projekt-ID oder Projektname

settingsType: TestResultsSettingsType

Gibt zurück

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

Gibt zurück

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

Gibt eine Testausführungsanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

attachmentId: number

Gibt zurück

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Gibt eine Testausführungsanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

attachmentId: number

Gibt zurück

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

includeDetails: boolean

includeTags: boolean

Gibt zurück

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

flags: number

Gibt zurück

Promise<TestRunCoverage[]>

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

Abrufen einer Liste der Referenz zu Testausführungsanlagen

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung

type: TestLogType

Typ der abzurufenden Anlagen

directoryPath: string

Verzeichnispfad, für den Anlagen erforderlich sind

fileNamePrefix: string

Dateinamepräfix zum Filtern der Liste der Anlagen

fetchMetaData: boolean

Der Standardwert ist "false", wenn Metadaten erforderlich sind.

top: number

Anzahl der zurückzugebenden Anlagen

continuationToken: String

Header zum Übergeben des Fortsetzungstokens

Gibt zurück

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Gibt die Anlage mit dem angegebenen Dateinamen für die angegebene runId aus dem LogStore zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Test RunId

filename: string

Dateiname der Anlage

Gibt zurück

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Gibt eine Liste von Anlagen für die angegebene RunId aus dem LogStore zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Test RunId

Gibt zurück

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

Gibt die Anlage mit dem angegebenen Dateinamen für die angegebene runId aus dem LogStore zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

Test RunId

filename: string

Dateiname der Anlage

Gibt zurück

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

Abrufen von Testausführungsnachrichtenprotokollen

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der abzurufenden Ausführung.

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

buildUri: string

owner: string

tmiRunId: string

planId: number

includeRunDetails: boolean

automated: boolean

skip: number

top: number

Gibt zurück

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

Ruft Testausführungen ab, die einer Sitzung zugeordnet sind

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

Parameter

project: string

Projekt-ID oder Projektname

sessionId: number

ID der TestResults-Sitzung, um Testausführungen abzurufen.

Gibt zurück

Promise<number[]>

getTestRunStatistics(string, number)

Get test run statistics , used when we want to get summary of a run by outcome.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der abzurufenden Ausführung.

Gibt zurück

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Abrufen der Testausführungszusammenfassung, die verwendet wird, wenn eine Zusammenfassung einer Ausführung nach Ergebnis abgerufen werden soll. Der Testlauf sollte im Status "Abgeschlossen" sein.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der abzurufenden Ausführung.

Gibt zurück

Promise<TestRunStatistic>

getTestSession(string, number)

Ruft das TestResultsSession-Metadatenobjekt im TCM-Datenspeicher ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Gibt zurück

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Ruft das TestResultsSession Layout-Objekt im TCM-Datenspeicher ab.

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

Parameter

project: string

Projekt-ID oder Projektname

sessionId: string

Gibt zurück

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Ruft das TestResultsSession Layout-Objekt im TCM-Datenspeicher ab.

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

Parameter

project: string

Projekt-ID oder Projektname

sessionId: number

Sitzungsobjekt abrufen.

Gibt zurück

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Gibt zurück

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

testSettingsId: number

Gibt zurück

Promise<TestSettings>

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

Gibt eine Testunterergebnisanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Gibt zurück

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Gibt Anlagenverweise für das Testunterergebnis zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

testSubResultId: number

Gibt zurück

Promise<TestAttachment[]>

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

Gibt eine Testunterergebnisanlage zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Gibt zurück

Promise<ArrayBuffer>

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

Abrufen einer Liste der Referenz zu Test-Subresult-Anlagen

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung, die die Ergebnisse enthält

resultId: number

ID des Testergebnisses, das Untergeordnetes Ergebnis enthält

subResultId: number

ID des Test-Unterergebnisses

type: TestLogType

Typ der abzurufenden Anlagen

directoryPath: string

Verzeichnispfad der abzurufenden Anlage

fileNamePrefix: string

Dateinamenpräfix zum Filtern der Liste der Anlagen

fetchMetaData: boolean

Der Standardwert ist "false", wenn Metadaten erforderlich sind.

top: number

Anzahl der zurückzugebenden Anlagen

continuationToken: String

Header zum Übergeben des Fortsetzungstokens

Gibt zurück

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Rufen Sie alle Tags in einem Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Build-ID

Gibt zurück

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Rufen Sie alle Tags in einer Version ab.

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

Release-ID

releaseEnvId: number

Versionsumgebungs-ID

Gibt zurück

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Rufen Sie alle Tags in einem Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Build-ID

Gibt zurück

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Rufen Sie alle Tags in einer Version ab.

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

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

Release-ID

releaseEnvId: number

Versionsumgebungs-ID

Gibt zurück

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

Parameter

document: TestResultDocument

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

Parameter

project: string

Projekt-ID oder Projektname

scopeFilter: CustomTestFieldScope

Gibt zurück

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parameter

filter: TestResultTrendFilter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parameter

filter: TestResultTrendFilter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Abrufen des Verlaufs einer Testmethode mithilfe von TestHistoryQuery

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

Parameter

filter: TestHistoryQuery

TestHistoryQuery zum Abrufen des Verlaufs

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parameter

project: string

Projekt-ID oder Projektname

testName: string

Gibt zurück

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

Parameter

filter: ResultsFilter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

Abrufen der Liste der Testergebnismetadatendetails für die entsprechende TestcasereferenceId

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

Parameter

testCaseReferenceIds: string[]

TestCaseReference-IDs des zu abfragenden Testergebnisses, durch Kommas getrennte Liste gültiger IDs (Grenzwert Nr. von IDs 200).

project: string

Projekt-ID oder Projektname

detailsToInclude: ResultMetaDataDetails

Details, die in Die Metadaten der Testergebnisse einbezogen werden sollen. Der Standardwert ist "None". Andere Werte sind FlakyIdentifier.

Gibt zurück

Promise<TestResultMetaData[]>

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

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Gibt zurück

Promise<TestResultSummary>

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

Abrufen einer Zusammenfassung der Testergebnisse.

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

Parameter

project: string

Projekt-ID oder Projektname

pipelineId: number

Pipeline-ID. Dies ist identisch mit der Build-ID.

stageName: string

Name der Stufe. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

phaseName: string

Name der Phase. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

jobName: string

includeFailureDetails: boolean

Wenn "true" Fehlererkenntnisse zurückgibt

Gibt zurück

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>

Parameter

project: string

Projekt-ID oder Projektname

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Gibt zurück

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parameter

releases: ReleaseReference[]

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestResultSummary[]>

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

Abfragetestergebnis-WorkItems basierend auf dem Filter

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

Parameter

project: string

Projekt-ID oder Projektname

workItemCategory: string

werte "Microsoft.BugCategory" oder "all(for getting all workitems)

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Gibt zurück

Promise<WorkItemReference[]>

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

Abfragetest wird basierend auf Filtern ausgeführt. Pflichtfelder sind "minLastUpdatedDate" und "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>>

Parameter

project: string

Projekt-ID oder Projektname

minLastUpdatedDate: Date

Mindestdatum der letzten Änderung, die abgefragt werden soll (verpflichtend).

maxLastUpdatedDate: Date

Maximale Letzte Änderungsdatum, die abgefragt werden soll (Obligatorisch, Differenz zwischen min und max. Datum kann höchstens 7 Tage betragen).

state: TestRunState

Aktueller Status der zu abfragenden Runs.

planIds: number[]

Plan-IDs der zu abfragenden Ausführung, kommagetrennte Liste gültiger IDs.

isAutomated: boolean

Automatisierungstyp der ausführung, die abgefragt werden soll.

publishContext: TestRunPublishContext

PublishContext der zu abfragenden Runs.

buildIds: number[]

Build-IDs der zu abfragenden Ausführung, kommagetrennte Liste gültiger IDs.

buildDefIds: number[]

Builddefinitions-IDs der zu abfragenden Ausführung, kommagetrennte Liste gültiger IDs.

branchName: string

Name des Quellzweigs der zu abfragenden Runs.

releaseIds: number[]

Release-IDs der zu abfragenden Ausführung, kommagetrennte Liste gültiger IDs.

releaseDefIds: number[]

Versionsdefinitions-IDs der zu abfragenden, kommagetrennten Liste gültiger IDs.

releaseEnvIds: number[]

Release Environment IDs of the Runs to be queried, comma separated list of valid ids.

releaseEnvDefIds: number[]

Release Environment Definition IDs of the Runs to be queried, comma separated list of valid ids.

runTitle: string

Run Title of the Runs to be queried.

top: number

Anzahl der zu abfragenden Läufe. Der Grenzwert beträgt 100

continuationToken: string

continuationToken, das vom vorherigen Batch oder null für den ersten Batch empfangen wurde. Es sollte nicht vom Benutzer erstellt (oder geändert werden, wenn er vom letzten Batch empfangen wird).

Gibt zurück

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parameter

resultsContext: TestResultsContext

project: string

Projekt-ID oder Projektname

workItemIds: number[]

Gibt zurück

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Erstellen und Abrufen von SAS-URI des Buildcontainers

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

ID des abzurufenden Builds

testLogStoreOperationType: TestLogStoreOperationType

Typ des auszuführenden Vorgangs mithilfe von SAS-URI

Gibt zurück

Promise<TestLogStoreEndpointDetails>

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

Erstellen einer leeren Datei für ein Ergebnis und Abrufen von Sas-URI für die Datei

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Testausführung, die das Ergebnis enthält

resultId: number

ID der Testergebnisse, die Unterergebnisse enthalten

subResultId: number

ID des Testunterergebnisses, dessen Datei-SAS-URI erforderlich ist

filePath: string

Dateipfad innerhalb des Unterergebnisses, für das SAS-URI erforderlich ist

type: TestLogType

Dateityp für den Download

Gibt zurück

Promise<TestLogStoreEndpointDetails>

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

Erstellen einer leeren Datei für eine Ausführung und Abrufen von Sas-URI für die Datei

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

Parameter

project: string

Projekt-ID oder Projektname

runId: number

ID der Ausführung zum Abrufen von Endpunktdetails

testLogStoreOperationType: TestLogStoreOperationType

Typ des auszuführenden Vorgangs mithilfe von SAS-URI

filePath: string

Dateipfad zum Erstellen einer leeren Datei

type: TestLogType

Default is GeneralAttachment, type of empty file to be created

Gibt zurück

Promise<TestLogStoreEndpointDetails>

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

Rufen Sie alle verfügbaren Gruppendetails ab, und für diese Gruppen werden fehler- und abgebrochene Ergebnisse angezeigt.

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

Parameter

project: string

Projekt-ID oder Projektname

pipelineId: number

Pipeline-ID. Dies ist identisch mit der Build-ID.

stageName: string

Name der Stufe. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

phaseName: string

Name der Phase. Die maximal unterstützte Länge für den Namen beträgt 256 Zeichen.

jobName: string

shouldIncludeFailedAndAbortedResults: boolean

Wenn "true", werden ids von fehlgeschlagenen und abgebrochenen Ergebnissen für jede Testgruppe zurückgegeben.

queryGroupSummaryForInProgress: boolean

Wenn true, wird auch die Zusammenfassung für InProgress-Ausführung berechnet.

Gibt zurück

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>

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

coverageData: CodeCoverageData

Gibt zurück

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

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

Parameter

updateCustomTestField: CustomTestFieldUpdateDefinition

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

Aktualisieren der Projekteinstellungen von Testergebnissen

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

Parameter

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

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

Parameter

results: TestCaseResult[]

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Aktualisieren von Eigenschaften von Testergebnismetadaten

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

Parameter

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData update input TestResultMetaDataUpdateInput

project: string

Projekt-ID oder Projektname

testCaseReferenceId: number

TestCaseReference-ID des zu aktualisierenden Testergebnisses.

Gibt zurück

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Erstellt TestResultsMRX-Objekte im TCM-Datenspeicher für vorhandene Testergebnisse

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

Parameter

results: TestCaseResult[]

Results-Objekt mit nur MRX-Testergebnissen und vorhandenen testResultId

project: string

Projekt-ID oder Projektname

runId: number

RunId des Testlaufs

Gibt zurück

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

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

Parameter

runUpdateModel: RunUpdateModel

project: string

Projekt-ID oder Projektname

runId: number

Gibt zurück

Promise<TestRun>

updateTestRunTags(TestTagsUpdateModel, string, number)

Aktualisieren von Tags einer Ausführung, Tags können hinzugefügt und gelöscht werden

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

Parameter

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

Projekt-ID oder Projektname

runId: number

RunId der Ausführung

Gibt zurück

Promise<TestTag[]>

Freigeben über

TestResultsRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

TestResultsRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

addCustomFields(CustomTestFieldDefinition[], string)

Parameter

Gibt zurück

addTestResultsToTestRun(TestCaseResult[], string, number)

Parameter

Gibt zurück

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Parameter

Gibt zurück

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parameter

Gibt zurück

createAnalysis(TestSessionAnalysis[], string, number)

Parameter

Gibt zurück

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Parameter

Gibt zurück

createEnvironment(TestSessionEnvironment[], string)

Parameter

Gibt zurück

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Parameter

Gibt zurück

createFailureType(TestResultFailureTypeRequestModel, string)

Parameter

Gibt zurück

createNotification(TestSessionNotification[], string, number)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parameter

Gibt zurück

createTestRun(RunCreateModel, string)

Parameter

Gibt zurück

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parameter

Gibt zurück

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Parameter

Gibt zurück

createTestSession(TestResultsSession, string)

Parameter

Gibt zurück

createTestSettings(TestSettings, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

deleteCustomFieldById(string, number)

Parameter

Gibt zurück

deleteFailureType(string, number)

Parameter

Gibt zurück

deleteTestMethodToWorkItemLink(string, string, number)

Parameter

Gibt zurück

deleteTestResultAttachment(string, number, number, number)

Parameter

Gibt zurück

deleteTestRun(string, number)

Parameter