TestRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Test |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
Details zum Konstruktor
TestRestClient(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
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
Fügen Sie der Suite Testfälle 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 Testsuite, zu 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)
Fügen Sie testergebnisse zu einer Testausführung hinzu.
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
Testausführungs-ID, zu der 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 zum 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 der Testausführung, die das Ergebnis enthält.
- testCaseResultId
-
number
ID des Testergebnisses, das die Iteration enthält
- iterationId
-
number
ID der Testergebnisiteration.
- actionPath
-
string
Hexwert des Testergebnisaktionspfads.
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 der Testausführung, die 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 eine neue Testausführung.
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>
Parameter
- testRun
- RunCreateModel
Ausführen von Details RunCreateModel
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
Fügen Sie eine Datei an eine Testausführung 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
Anlagenanforderungsmodell.
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, die das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die Unterergebnisse enthalten.
- testSubResultId
-
number
ID der Testunterergebnisse, anhand derer Anlagen hochgeladen werden müssen.
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)
Rufen Sie Codeabdeckungsdaten 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 Codeabdeckungsdaten abgerufen werden müssen.
- flags
-
number
Der Wert von Flags bestimmt die Ebene der Codeabdeckungsdetails, die abgerufen werden sollen. Kennzeichnungen sind additiv. Erwartete Werte sind 1 für Module, 2 für Funktionen, 4 für BlockData.
Gibt zurück
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
Abrufen der Codeabdeckungszusammenfassung für Build.
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 Codeabdeckungsdaten 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 der Feldnamen der Arbeitsaufgabe.
Gibt zurück
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
Dient zum Abrufen einer Liste von Testpunkten.
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 der Feldnamen der Arbeitsaufgabe.
- configurationId
-
string
Abrufen von Testpunkten für bestimmte Konfigurationen.
- testCaseId
-
string
Abrufen von Testpunkten für einen bestimmten Testfall, gültig, wenn configurationId nicht festgelegt ist.
- testPointIds
-
string
Abrufen von Testpunkten für eine durch Trennzeichen getrennte Liste von Testpunkt-IDs, die nur gültig sind, 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 von Testergebnisaufbewahrungseinstellungen
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 Testsuite mit 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)
Rufen Sie alle Testfälle in einer Suite ab.
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 der Testausführung, die 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 (Bestanden/Fehlschlagen) von Testschritten, die als Teil eines ausgeführten 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 der Testausführung, die 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 (Bestanden/Fehlschlagen) von Testschritten, die als Teil eines ausgeführten 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 der Testausführung, die 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)
Liste der Referenz zu Testergebnisanlagen abrufen.
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>
Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, die 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 der Testausführung, die 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 eine Testausführung.
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 mit Testergebnissen einbezogen werden sollen. Der Standardwert ist "None". Andere 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 eine Testausführung.
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 mit Testergebnissen einbezogen werden sollen. Der Standardwert ist "None". Andere Werte sind Iterationen und WorkItems.
- skip
-
number
Die Anzahl der Testergebnisse, die von Anfang an übersprungen werden sollen.
- top
-
number
Anzahl der zurückzugebenden Testergebnisse. Maximum ist 1000, wenn detailsToInclude "None" und andernfalls 200 ist.
- 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 von IDs mit Feldern zurück, die für bestimmte automatisierte Testmethoden angegeben/trend angegeben sind. Wir verbessern diese API noch 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 Testausführungsanlage 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 zu herunterladenden Testausführungsanlage.
Gibt zurück
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
Dient zum Abrufen der Liste der Referenz zu Testausführungsanlagen.
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>
Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung.
Gibt zurück
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
Laden Sie eine Testausführungsanlage 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 zu herunterladenden Testausführungsanlage.
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 Codeabdeckungsdaten für eine Testausführung
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>
Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, für die Codeabdeckungsdaten abgerufen werden müssen.
- flags
-
number
Der Wert von Flags bestimmt die Ebene der Codeabdeckungsdetails, die abgerufen werden sollen. Kennzeichnungen sind additiv. Erwartete Werte sind 1 für Module, 2 für Funktionen, 4 für BlockData.
Gibt zurück
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
Abrufen von Testausführungsnachrichtenprotokollen
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)
Dient zum Abrufen einer Liste von Testläufen.
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, der von der Ausführung verwendet wird.
- owner
-
string
Team Foundation-ID des Besitzers der Ausführung.
- tmiRunId
-
string
- planId
-
number
Die ID des Testplans, von dem die Ausführung ausgeführt wird, sind Teil des Tests.
- includeRunDetails
-
boolean
Wenn true, schließen Sie alle Eigenschaften der Ausführung ein.
- automated
-
boolean
Wenn "true" ist, werden nur automatisierte Ausführungen zurückgegeben.
- 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 wir eine Zusammenfassung eines Laufs nach Ergebnis abrufen möchten.
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 ab jetzt, für die Testsitzungen abgerufen werden.
- allSessions
-
boolean
Wenn "false" zurückgegeben wird, werden Testsitzungen für den aktuellen Benutzer zurückgegeben. Andernfalls werden Testsitzungen für alle Benutzer zurückgegeben.
- includeAllProperties
-
boolean
Ist "true", werden alle Eigenschaften der Testsitzungen zurückgegeben. Andernfalls wird die skinny-Version zurückgegeben.
- source
- TestSessionSource
Quelle der Testsitzung.
- includeOnlyCompletedSessions
-
boolean
Wenn true, gibt es Testsitzungen im abgeschlossenen Zustand 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 der Testausführung, die das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die Unterergebnisse enthalten.
- attachmentId
-
number
ID der herunterzuladenden Testergebnisanlage
- testSubResultId
-
number
ID des Testunterergebnisses, dessen Anlage heruntergeladen werden muss
Gibt zurück
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
Liste der Testunterergebnisanlagen abrufen
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>
Parameter
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der Testausführung, die das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die Unterergebnisse enthalten.
- testSubResultId
-
number
ID des Testunterergebnisses, 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 der Testausführung, die das Ergebnis enthält.
- testCaseResultId
-
number
ID der Testergebnisse, die Unterergebnisse enthalten.
- attachmentId
-
number
ID der herunterzuladenden Testergebnisanlage
- testSubResultId
-
number
ID des Testunterergebnisses, dessen Anlage heruntergeladen werden muss
Gibt zurück
Promise<ArrayBuffer>
processSuitesForStaging(StagedSuitesRequestModel, string, number)
Verarbeitet eine Sammlung von Testsammlungen und gibt ein Antwortmodell zurück, das Suite- und Testfalldetails enthält.
function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>
Parameter
- request
- StagedSuitesRequestModel
Das Anforderungsmodell, das die zu verarbeitenden Testsuiten enthält. Kann nicht NULL sein.
- project
-
string
Projekt-ID oder Projektname
- workItemId
-
number
Gibt zurück
Promise<StagedSuitesResponseModel>
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 Testergebnismetadatendetails für die entsprechende TestcasereferenceId
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>
Parameter
- testReferenceIds
-
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
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)
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 (Grenzwert Nr. von IDs 10).
- 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 (Grenzwert Nr. von IDs 10).
- buildDefIds
-
number[]
Builddefinitions-IDs der zu abfragenden Ausführung, kommagetrennte Liste gültiger IDs (Grenzwert Nr. von IDs 10).
- branchName
-
string
Name des Quellzweigs der zu abfragenden Runs.
- releaseIds
-
number[]
Release-IDs der zu abfragenden Ausführung, kommagetrennte Liste gültiger IDs (Grenzwert Nr. von IDs 10).
- releaseDefIds
-
number[]
Versionsdefinitions-IDs der abzufragenden Runs, kommagetrennte Liste gültiger IDs (Grenzwert Nr. von IDs 10).
- releaseEnvIds
-
number[]
Release Environment IDs of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
- releaseEnvDefIds
-
number[]
Release Environment Definition IDs of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
- runTitle
-
string
Lauftitel der Ausführungen, die abgefragt werden sollen.
- 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
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 Testpunkte, die den Testfällen zugeordnet sind, werden aus der Testsuite entfernt. Die Arbeitsaufgabe für Testfälle wird nicht aus dem System gelöscht. Lesen Sie die Ressource "Testfälle", um einen Testfall dauerhaft zu löschen.
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 abzurufenden 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 Anforderung: Json der Codeabdeckung Zusammenfassung
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 Aufbewahrungseinstellungen für Testergebnisse
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>
Parameter
- retentionSettings
- ResultRetentionSettings
Details der Testergebnisaufbewahrungseinstellungen, die aktualisiert werden sollen
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
Aktualisiert 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 Testfall-Suite-Zuordnung.
- project
-
string
Projekt-ID oder Projektname
- planId
-
number
ID des Testplans, der die Suite enthält.
- suiteId
-
number
ID der Testsuite, zu 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[]>
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 der 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 den Test, der anhand seiner ID ausgeführt wird.
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>
Parameter
- runUpdateModel
- RunUpdateModel
RunUpdateModel ausführen
- project
-
string
Projekt-ID oder Projektname
- runId
-
number
ID der auszuführenden Aktualisierung.
Gibt zurück
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
Aktualisieren einer Testsitzung
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>
Parameter
- testSession
- TestSession
Testsitzungsdetails für Update
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
Gibt zurück
Promise<TestSession>