TestRestClient class
Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).
- Extends
Konstruktoren
| Test |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
Details zum Konstruktor
TestRestClient(IVssRestClientOptions)
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>Parameter
- newFields
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
Fügen Sie Testfälle zur Suite hinzu.
function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans, der die Suite enthält.
- suiteId
-
number
ID der Testsammlung, der die Testfälle hinzugefügt werden müssen.
- testCaseIds
-
string
IDs der Testfälle, die der Suite hinzugefügt werden sollen. IDs werden im durch Trennzeichen getrennten Format angegeben.
Gibt zurück
Promise<SuiteTestCase[]>
addTestResultsToTestRun(TestCaseResult[], string, number)
Hinzufügen von Testergebnissen zu einem Testlauf.
function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>Parameter
- results
Liste der hinzuzufügenden Testergebnisse.
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
Testlauf-ID, in die Testergebnisse hinzugefügt werden sollen.
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>
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
Anfügen einer Datei an das Testschrittergebnis
function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>Parameter
- attachmentRequestModel
- TestAttachmentRequestModel
Anlagendetails TestAttachmentRequestModel
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID des Testergebnisses, das die Iteration enthält
- iterationId
-
number
ID der Testergebnisiteration.
- actionPath
-
string
Hexadywert des Aktionspfads des Testergebnisses.
Gibt zurück
Promise<TestAttachmentReference>
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
Fügen Sie eine Datei an ein Testergebnis an.
function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>Parameter
- attachmentRequestModel
- TestAttachmentRequestModel
Anlagendetails TestAttachmentRequestModel
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID des Testergebnisses, für das die Anlage hochgeladen werden muss.
Gibt zurück
Promise<TestAttachmentReference>
createTestRun(RunCreateModel, string)
Erstellen Sie einen neuen Testlauf.
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>Parameter
- testRun
- RunCreateModel
Ausführungsdetails RunCreateModel
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
Fügen Sie eine Datei an einen Testlauf an.
function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>Parameter
- attachmentRequestModel
- TestAttachmentRequestModel
Anlagendetails TestAttachmentRequestModel
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, für die die Anlage hochgeladen werden muss.
Gibt zurück
Promise<TestAttachmentReference>
createTestSession(TestSession, TeamContext)
Erstellen einer Testsitzung
function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>Parameter
- testSession
- TestSession
Testsitzungsdetails für die Erstellung
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
Gibt zurück
Promise<TestSession>
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)
Anfügen einer Datei an ein Testergebnis
function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>Parameter
- attachmentRequestModel
- TestAttachmentRequestModel
Attachment Request Model( Attachment Request Model).
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die das Teilergebnis enthält.
- testSubResultId
-
number
ID der Testunterteilergebnisse, für die die Anlage hochgeladen werden muss.
Gibt zurück
Promise<TestAttachmentReference>
deleteSharedParameter(string, number)
function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- sharedParameterId
-
number
Gibt zurück
Promise<void>
deleteSharedStep(string, number)
function deleteSharedStep(project: string, sharedStepId: number): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- sharedStepId
-
number
Gibt zurück
Promise<void>
deleteTestCase(string, number)
Löschen sie einen Testfall.
function deleteTestCase(project: string, testCaseId: number): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- testCaseId
-
number
ID des zu löschenden Testfalls.
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>
deleteTestRun(string, number)
Löschen Sie einen Test, der anhand seiner ID ausgeführt wird.
function deleteTestRun(project: string, runId: number): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der zu löschenden Ausführung.
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>
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)
Ruft Code Coverage-Daten für einen Build ab.
function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- buildId
-
number
ID des Builds, für den Code Coverage-Daten abgerufen werden müssen.
- flags
-
number
Der Wert von Flags bestimmt die Ebene der abzurufenden Code Coverage-Details. Flags sind additiv. Erwartete Werte sind 1 für Module, 2 für Funktionen und 4 für BlockData.
Gibt zurück
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
Rufen Sie die Code Coverage Summary for Build ab.
function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>Parameter
- project
-
string
Projekt-ID oder Projektname
- buildId
-
number
ID des Builds, für den Code Coverage-Daten abgerufen werden müssen.
- deltaBuildId
-
number
Delta-Build-ID (optional)
Gibt zurück
Promise<CodeCoverageSummary>
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>Parameter
- workItemQuery
- LinkedWorkItemsQuery
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<LinkedWorkItemsQueryResult[]>
getPoint(string, number, number, number, string)
Abrufen eines Testpunkts.
function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>Parameter
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans.
- suiteId
-
number
ID der Suite, die den Punkt enthält.
- pointIds
-
number
ID des abzurufenden Testpunkts.
- witFields
-
string
Durch Trennzeichen getrennte Liste von Arbeitselementfeldnamen.
Gibt zurück
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
Rufen Sie eine Liste der Testpunkte ab.
function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans.
- suiteId
-
number
ID der Suite, die die Punkte enthält.
- witFields
-
string
Durch Trennzeichen getrennte Liste von Arbeitselementfeldnamen.
- configurationId
-
string
Abrufen von Testpunkten für eine bestimmte Konfiguration.
- testCaseId
-
string
Abrufen von Testpunkten für einen bestimmten Testfall, gültig, wenn configurationId nicht festgelegt ist.
- testPointIds
-
string
Abrufen von Testpunkten für durch Trennzeichen getrennte Liste von Testpunkt-IDs, nur gültig, wenn configurationId und testCaseId nicht festgelegt sind.
- includePointDetails
-
boolean
Schließen Sie alle Eigenschaften für den Testpunkt ein.
- skip
-
number
Anzahl der zu überspringenden Testpunkte.
- top
-
number
Anzahl der zurückzugebenden Testpunkte.
Gibt zurück
Promise<TestPoint[]>
getPointsByQuery(TestPointsQuery, string, number, number)
Abrufen von Testpunkten mithilfe der Abfrage.
function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>Parameter
- query
- TestPointsQuery
TestPointsQuery zum Abrufen von Testpunkten.
- project
-
string
Projekt-ID oder Projektname
- skip
-
number
Anzahl der zu überspringenden Testpunkte.
- top
-
number
Anzahl der zurückzugebenden Testpunkte.
Gibt zurück
Promise<TestPointsQuery>
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>>
getResultRetentionSettings(string)
Abrufen der Aufbewahrungseinstellungen für Testergebnisse
function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>Parameter
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<ResultRetentionSettings>
getTestCaseById(string, number, number, number)
Rufen Sie einen bestimmten Testfall in einer Testsammlung mit der Testfall-ID ab.
function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>Parameter
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans, der die Suites enthält.
- suiteId
-
number
ID der Suite, die den Testfall enthält.
- testCaseIds
-
number
ID des abzurufenden Testfalls.
Gibt zurück
Promise<SuiteTestCase>
getTestCases(string, number, number)
Abrufen aller Testfälle in einer Suite.
function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans, der die Suites enthält.
- suiteId
-
number
ID der abzurufenden Suite.
Gibt zurück
Promise<SuiteTestCase[]>
getTestIteration(string, number, number, number, boolean)
Abrufen einer Iteration für ein Ergebnis
function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID des Testergebnisses, das die Iterationen enthält.
- iterationId
-
number
ID der Testergebnisse Iteration.
- includeActionResults
-
boolean
Schließen Sie Ergebnisdetails für jede Aktion ein, die in der Testiteration ausgeführt wird. ActionResults beziehen sich auf das Ergebnis (Pass/Fail) von Testschritten, die im Rahmen eines manuellen Tests ausgeführt werden. Das Einschließen des ActionResults-Flags ruft das Ergebnis der Testschritte im Abschnitt actionResults und Testparameter im Parameterabschnitt für jede Testiteration ab.
Gibt zurück
Promise<TestIterationDetailsModel>
getTestIterations(string, number, number, boolean)
Abrufen von Iterationen für ein Ergebnis
function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID des Testergebnisses, das die Iterationen enthält.
- includeActionResults
-
boolean
Schließen Sie Ergebnisdetails für jede Aktion ein, die in der Testiteration ausgeführt wird. ActionResults beziehen sich auf das Ergebnis (Pass/Fail) von Testschritten, die im Rahmen eines manuellen Tests ausgeführt werden. Das Einschließen des ActionResults-Flags ruft das Ergebnis der Testschritte im Abschnitt actionResults und Testparameter im Parameterabschnitt für jede Testiteration ab.
Gibt zurück
Promise<TestIterationDetailsModel[]>
getTestResultAttachmentContent(string, number, number, number)
Laden Sie eine Testergebnisanlage anhand ihrer ID herunter.
function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der die testCaseResultId enthält.
- testCaseResultId
-
number
ID des Testergebnisses, dessen Anlage heruntergeladen werden muss.
- attachmentId
-
number
ID der herunterzuladenden Testergebnisanlage.
Gibt zurück
Promise<ArrayBuffer>
getTestResultAttachments(string, number, number)
Ruft eine Liste der Referenz zu Testergebnisanlagen ab.
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID des Testergebnisses.
Gibt zurück
Promise<TestAttachment[]>
getTestResultAttachmentZip(string, number, number, number)
Laden Sie eine Testergebnisanlage anhand ihrer ID herunter.
function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der die testCaseResultId enthält.
- testCaseResultId
-
number
ID des Testergebnisses, dessen Anlage heruntergeladen werden muss.
- attachmentId
-
number
ID der herunterzuladenden Testergebnisanlage.
Gibt zurück
Promise<ArrayBuffer>
getTestResultById(string, number, number, ResultDetails)
Abrufen eines Testergebnisses für einen Testlauf.
function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
Testlauf-ID eines abzurufenden Testergebnisses.
- testCaseResultId
-
number
Testergebnis-ID.
- detailsToInclude
- ResultDetails
Details, die in Testergebnisse eingeschlossen werden sollen. Der Standardwert ist None. Weitere Werte sind Iterationen, WorkItems und SubResults.
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>
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])
Abrufen von Testergebnissen für einen Testlauf.
function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
Testlauf-ID der abzurufenden Testergebnisse.
- detailsToInclude
- ResultDetails
Details, die in Testergebnisse eingeschlossen werden sollen. Der Standardwert ist None. Weitere Werte sind Iterationen und WorkItems.
- skip
-
number
Anzahl der Testergebnisse, die von Anfang an übersprungen werden sollen.
- top
-
number
Anzahl der zurückzugebenden Testergebnisse. Maximum ist 1000, wenn detailsToInclude den Wert None und andernfalls 200 hat.
- outcomes
Durch Trennzeichen getrennte Liste der Testergebnisse zum Filtern von Testergebnissen.
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
- top
-
number
- continuationToken
-
string
Gibt zurück
Promise<PagedList<ShallowTestCaseResult>>
getTestResultsByQuery(TestResultsQuery, string)
Diese API gibt Ergebnisse nach IDs mit angegebenen Feldern/Trend für eine bestimmte automatisierte Testmethode zurück. Wir sind noch dabei, diese API zu verbessern und haben keine ordnungsgemäße Signatur und keinen Vertrag abgeschlossen.
function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>Parameter
- query
- TestResultsQuery
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TestResultsQuery>
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
- top
-
number
- continuationToken
-
string
Gibt zurück
Promise<PagedList<ShallowTestCaseResult>>
getTestRunAttachmentContent(string, number, number)
Laden Sie eine Testlaufanlage anhand ihrer ID herunter.
function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, deren Anlage heruntergeladen werden muss.
- attachmentId
-
number
ID der herunterzuladenden Testlaufanlage.
Gibt zurück
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
Rufen Sie die Liste der Referenz zu Testlaufanlagen ab.
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs.
Gibt zurück
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
Laden Sie eine Testlaufanlage anhand ihrer ID herunter.
function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, deren Anlage heruntergeladen werden muss.
- attachmentId
-
number
ID der herunterzuladenden Testlaufanlage.
Gibt zurück
Promise<ArrayBuffer>
getTestRunById(string, number, boolean)
Rufen Sie einen Test ab, der anhand seiner ID ausgeführt wird.
function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der abzurufenden Ausführung.
- includeDetails
-
boolean
Der Standardwert ist true. Sie enthält Details wie Ausführungsstatistiken, Release, Build, Testumgebung, Status nach dem Prozess und vieles mehr.
Gibt zurück
Promise<TestRun>
getTestRunCodeCoverage(string, number, number)
Abrufen von Code Coverage-Daten für einen Testlauf
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, für den Code Coverage-Daten abgerufen werden müssen.
- flags
-
number
Der Wert von Flags bestimmt die Ebene der abzurufenden Code Coverage-Details. Flags sind additiv. Erwartete Werte sind 1 für Module, 2 für Funktionen und 4 für BlockData.
Gibt zurück
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
Abrufen von Testlaufmeldungsprotokollen
function getTestRunLogs(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)
Rufen Sie eine Liste der Testläufe ab.
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
URI des Builds, den die Ausführung verwendet hat.
- owner
-
string
Team foundation ID des Besitzers der Ausführungen.
- tmiRunId
-
string
- planId
-
number
ID des Testplans, zu dem die Ausführungen gehören.
- includeRunDetails
-
boolean
Wenn true, schließen Sie alle Eigenschaften der Ausführungen ein.
- automated
-
boolean
Wenn true, gibt nur automatisierte Ausführungen zurück.
- skip
-
number
Anzahl der zu überspringenden Testläufe.
- top
-
number
Anzahl der zurückzugebenden Testläufe.
Gibt zurück
Promise<TestRun[]>
getTestRunStatistics(string, number)
Abrufen von Testlaufstatistiken , die verwendet werden, wenn eine Zusammenfassung einer Ausführung nach Ergebnis abgerufen werden soll.
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>
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)
Abrufen einer Liste von Testsitzungen
function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>Parameter
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- period
-
number
Zeitraum in Tagen, für den Testsitzungen abgerufen werden.
- allSessions
-
boolean
Wenn false, gibt Testsitzungen für den aktuellen Benutzer zurück. Andernfalls werden Testsitzungen für alle Benutzer zurückgegeben.
- includeAllProperties
-
boolean
Wenn true, werden alle Eigenschaften der Testsitzungen zurückgegeben. Andernfalls wird die dünne Version zurückgegeben.
- source
- TestSessionSource
Quelle der Testsitzung.
- includeOnlyCompletedSessions
-
boolean
Wenn true, gibt es Testsitzungen im Zustand abgeschlossen zurück. Andernfalls werden Testsitzungen für alle Zustände zurückgegeben.
Gibt zurück
Promise<TestSession[]>
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)
Herunterladen einer Testunterergebnisanlage
function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die das Teilergebnis enthalten.
- attachmentId
-
number
ID der zu downloadden Testergebnisanlage
- testSubResultId
-
number
ID des Testteilergebnisses, dessen Anlage heruntergeladen werden muss
Gibt zurück
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
Abrufen der Liste der Testunterergebnisanlagen
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die das Teilergebnis enthalten.
- testSubResultId
-
number
ID des Testteilergebnisses, dessen Anlage heruntergeladen werden muss
Gibt zurück
Promise<TestAttachment[]>
getTestSubResultAttachmentZip(string, number, number, number, number)
Herunterladen einer Testunterergebnisanlage
function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID des Testlaufs, der das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die das Teilergebnis enthalten.
- attachmentId
-
number
ID der zu downloadden Testergebnisanlage
- testSubResultId
-
number
ID des Testteilergebnisses, dessen Anlage heruntergeladen werden muss
Gibt zurück
Promise<ArrayBuffer>
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)
Abrufen der Liste der Metadatendetails des Testergebnisses für entsprechende testcasereferenceId
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>Parameter
- testReferenceIds
-
string[]
TestCaseReference-IDs des abzufragenden Testergebnisses, durch Kommas getrennte Liste gültiger IDs (Grenzwert von IDs 200).
- project
-
string
Projekt-ID oder Projektname
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>
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
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TestResultSummary[]>
queryTestResultWorkItems(string, string, string, number, Date, number, number)
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
- 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)
Abfragetestausführungen basierend auf Filtern. 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 der ausführung, die abgefragt werden soll (Obligatorisch).
- maxLastUpdatedDate
-
Date
Maximum Last Modified Date of run to beabfrage (Obligatorisch, Differenz zwischen min- und max. Datum kann maximal 7 Tage betragen).
- state
- TestRunState
Aktueller Status der abzufragten Ausführungen.
- planIds
-
number[]
Plan-IDs der zu abfragenden Ausführungen, kommagetrennte Liste der gültigen IDs (Grenzwert von ID 10).
- isAutomated
-
boolean
Automatisierungstyp der abzufragten Ausführungen.
- publishContext
- TestRunPublishContext
PublishContext der abzufragten Ausführungen.
- buildIds
-
number[]
Erstellen Sie ids der abzufragbaren Ausführungen, kommagetrennte Liste der gültigen IDs (Grenzwert von IDs 10).
- buildDefIds
-
number[]
Erstellen Sie Definition-IDs der zu abfragenden Ausführungen, durch Kommas getrennte Liste gültiger IDs (Grenzwert von ids 10).
- branchName
-
string
Quellbranchname der abzufragenden Ausführungen.
- releaseIds
-
number[]
Release-IDs der zu abfragenden Ausführungen, kommagetrennte Liste gültiger IDs (Grenzwert von ID 10).
- releaseDefIds
-
number[]
Releasedefinitions-IDs der zu abfragenden Ausführungen, durch Kommas getrennte Liste gültiger IDs (Grenzwert von ID 10).
- releaseEnvIds
-
number[]
Freigeben von Umgebungs-IDs der zu abfragenden Ausführungen, durch Kommas getrennte Liste gültiger IDs (Grenzwert von IDs 10).
- releaseEnvDefIds
-
number[]
Freigeben von Umgebungsdefinitions-IDs der zu abfragenden Ausführungen, durch Kommas getrennte Liste gültiger IDs (Grenzwert von ids 10).
- runTitle
-
string
Ausführungstitel der abzufragten Ausführungen.
- top
-
number
Anzahl der abzufragbaren Ausführungen. Grenzwert ist 100
- continuationToken
-
string
continuationToken vom vorherigen Batch oder NULL für den ersten Batch. Es sollte nicht vom Benutzer erstellt (oder geändert werden, wenn es vom letzten Batch empfangen wurde).
Gibt zurück
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[]>
removeTestCasesFromSuiteUrl(string, number, number, string)
Die den Testfällen zugeordneten Testpunkte werden aus der Testsuite entfernt. Das Testfallarbeitselement wird nicht aus dem System gelöscht. Informationen zum dauerhaften Löschen eines Testfalls finden Sie in der Testfallressource.
function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans, der die Suite enthält.
- suiteId
-
number
ID der zu erhaltenden Suite.
- testCaseIds
-
string
IDs der Testfälle, die aus der Suite entfernt werden sollen.
Gibt zurück
Promise<void>
updateCodeCoverageSummary(CodeCoverageData, string, number)
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: JSON of code coverage summary
function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>Parameter
- coverageData
- CodeCoverageData
- project
-
string
Projekt-ID oder Projektname
- buildId
-
number
Gibt zurück
Promise<void>
updateResultRetentionSettings(ResultRetentionSettings, string)
Aktualisieren der Einstellungen für die Aufbewahrung von Testergebnissen
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>Parameter
- retentionSettings
- ResultRetentionSettings
Zu aktualisierende Testergebnisaufbewahrungseinstellungen
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
Updates die Eigenschaften der Testfallzuordnung in einer Suite.
function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>Parameter
- suiteTestCaseUpdateModel
- SuiteTestCaseUpdateModel
Modell für die Updation der Eigenschaften der Testfallsammlungszuordnung.
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans, der die Suite enthält.
- suiteId
-
number
ID der Testsuite, der die Testfälle hinzugefügt werden müssen.
- testCaseIds
-
string
IDs der Testfälle, die der Suite hinzugefügt werden sollen. Ids werden in kommagetrennten Format angegeben.
Gibt zurück
Promise<SuiteTestCase[]>
updateTestPoints(PointUpdateModel, string, number, number, string)
Aktualisieren sie Testpunkte.
function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>Parameter
- pointUpdateModel
- PointUpdateModel
Zu aktualisierende Daten.
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans.
- suiteId
-
number
ID der Suite, die die Punkte enthält.
- pointIds
-
string
ID des abzurufenden Testpunkts. Verwenden Sie eine durch Trennzeichen getrennte Liste von IDs, um mehrere Testpunkte zu aktualisieren.
Gibt zurück
Promise<TestPoint[]>
updateTestResults(TestCaseResult[], string, number)
Aktualisieren Sie die Testergebnisse in einer Testausführung.
function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>Parameter
- results
Liste der zu aktualisierenden Testergebnisse.
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
Testlauf-ID, deren Testergebnisse aktualisiert werden sollen.
Gibt zurück
Promise<TestCaseResult[]>
updateTestRun(RunUpdateModel, string, number)
Aktualisieren Sie die Testausführung anhand ihrer ID.
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>Parameter
- runUpdateModel
- RunUpdateModel
Ausführungsdetails RunUpdateModel
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der zu aktualisierenden Ausführung.
Gibt zurück
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
Aktualisieren einer Testsitzung
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>Parameter
- testSession
- TestSession
Testen von Sitzungsdetails für das Update
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
Gibt zurück
Promise<TestSession>
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für