TestPlanRestClient class

Paket:: azure-devops-extension-api

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

Extends: RestClientBase

Konstruktoren

TestPlanRestClient(IVssRestClientOptions)

Methoden

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Hinzufügen von Testfällen zu einer Suite mit angegebenen Konfigurationen
cloneTestCase(CloneTestCaseParams, string)
cloneTestPlan(CloneTestPlanParams, string, boolean)	Klonen-Testplan
cloneTestSuite(CloneTestSuiteParams, string, boolean)	Klonen-Testsuite
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)	Erstellen Sie massenanforderungsbasierte Testsuiten.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Erstellen Sie eine Testkonfiguration.
createTestPlan(TestPlanCreateParams, string)	Erstellen Sie einen Testplan.
createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)	Erstellen Sie einen Testplan mit Testfällen, indem Sie einen Auftrag in die Warteschlange einreihen.
createTestSuite(TestSuiteCreateParams, string, number)	Erstellen Sie Testsuite.
createTestVariable(TestVariableCreateUpdateParameters, string)	Erstellen Sie eine Testvariable.
deleteTestCase(string, number)	Löschen sie einen Testfall.
deleteTestConfguration(string, number)	Löschen Sie eine Testkonfiguration anhand ihrer ID.
deleteTestPlan(string, number)	Löschen eines Testplans.
deleteTestSuite(string, number, number)	Testsuite löschen.
deleteTestVariable(string, number)	Löschen Sie eine Testvariable anhand ihrer ID.
exportTestCases(ExportTestCaseParams, string)	Exportiert eine Reihe von Testfällen aus einer Suite in eine Datei. Derzeit unterstützte Formate: xlsx
getCloneInformation(string, number)	Abrufen von Kloninformationen.
getDeletedTestPlans(string, string)	Abrufen einer Liste gelöschter Testpläne
getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Abrufen gelöschter Testsammlungen für einen Testplan.
getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)	Abrufen gelöschter Testsuiten innerhalb eines Projekts.
getPoints(string, number, number, string, boolean, boolean)	Erhalten Sie einen bestimmten Testpunkt aus einer Suite.
getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)	Abrufen aller Punkte innerhalb einer Suite basierend auf einigen Filtern
getSuiteCloneInformation(string, number)	Abrufen von Kloninformationen.
getSuiteEntries(string, number, SuiteEntryTypes)	Rufen Sie eine Liste der Testsuiteeinträge in der Testsuite ab.
getSuitesByTestCaseId(number)	Suchen Sie die Liste aller Testsuiten, in denen ein bestimmter Testfall vorhanden ist. Dies ist hilfreich, wenn Sie herausfinden müssen, welche Testsuiten einen Testfall verwenden, wenn Sie Änderungen an einem Testfall vornehmen müssen.
getTestCase(string, number, number, string, string, boolean)	Erhalten Sie einen bestimmten Testfall aus einer Suite.
getTestCaseCloneInformation(string, number)	Abrufen von Kloninformationen.
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)	Get Test Case List return those test cases which have all the configuration IDs as mentioned in the optional parameter. Wenn Konfigurations-IDs null sind, werden alle Testfälle zurückgegeben.
getTestConfigurationById(string, number)	Abrufen einer Testkonfiguration
getTestConfigurations(string, string)	Dient zum Abrufen einer Liste von Testkonfigurationen.
getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)
getTestPlanById(string, number)	Abrufen eines Testplans nach ID.
getTestPlans(string, string, string, boolean, boolean)	Abrufen einer Liste von Testplänen
getTestSuiteById(string, number, number, SuiteExpand)	Abrufen der Testsuite nach Suite-ID.
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Abrufen von Testsuiten für den Plan.
getTestVariableById(string, number)	Rufen Sie eine Testvariable anhand ihrer ID ab.
getTestVariables(string, string)	Dient zum Abrufen einer Liste von Testvariablen.
removeTestCasesFromSuite(string, number, number, string)	Entfernt Testfälle aus einer Suite basierend auf der Liste der bereitgestellten Testfall-IDs.
removeTestCasesListFromSuite(string, number, number, string)	Entfernt Testfälle aus einer Suite basierend auf der Liste der bereitgestellten Testfall-IDs. Diese API kann verwendet werden, um eine größere Anzahl von Testfällen zu entfernen.
reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)	Neuanordnen von Testsuiteeinträgen in der Testsuite.
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	Stellt den gelöschten Testplan wieder her
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	Stellt die gelöschte Testsuite wieder her
updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Aktualisieren der Konfigurationen für Testfälle
updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)	Aktualisieren Sie eine Testkonfiguration anhand ihrer ID.
updateTestPlan(TestPlanUpdateParams, string, number)	Aktualisieren eines Testplans.
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	Testpunkte aktualisieren. Dies wird verwendet, um den Testpunkt auf aktiv zurückzusetzen, das Ergebnis eines Testpunkts zu aktualisieren oder den Tester eines Testpunkts zu aktualisieren.
updateTestSuite(TestSuiteUpdateParams, string, number, number)	Aktualisieren sie die Testsuite.
updateTestVariable(TestVariableCreateUpdateParameters, string, number)	Aktualisieren Sie eine Testvariable anhand ihrer ID.

Details zum Konstruktor

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Methode

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Hinzufügen von Testfällen zu einer Suite mit angegebenen Konfigurationen

function addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Parameter

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters-Objekt.

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, dem Testfälle hinzugefügt werden sollen.

suiteId: number

ID der Testsuite, zu der Testfälle hinzugefügt werden sollen.

Gibt zurück

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

function cloneTestCase(cloneRequestBody: CloneTestCaseParams, project: string): Promise<CloneTestCaseOperationInformation>

Parameter

cloneRequestBody: CloneTestCaseParams

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<CloneTestCaseOperationInformation>

cloneTestPlan(CloneTestPlanParams, string, boolean)

Klonen-Testplan

function cloneTestPlan(cloneRequestBody: CloneTestPlanParams, project: string, deepClone?: boolean): Promise<CloneTestPlanOperationInformation>

Parameter

cloneRequestBody: CloneTestPlanParams

Plan Clone Request Body detail TestPlanCloneRequest

project: string

Projekt-ID oder Projektname

deepClone: boolean

Klonen aller zugeordneten Testfälle

Gibt zurück

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Klonen-Testsuite

function cloneTestSuite(cloneRequestBody: CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<CloneTestSuiteOperationInformation>

Parameter

cloneRequestBody: CloneTestSuiteParams

Suite Clone Anfrage Detail Text TestSuiteCloneAnfrage

project: string

Projekt-ID oder Projektname

deepClone: boolean

Klonen aller zugeordneten Testfälle

Gibt zurück

Promise<CloneTestSuiteOperationInformation>

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Erstellen Sie massenanforderungsbasierte Testsuiten.

function createBulkTestSuites(testSuiteCreateParams: TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestSuite[]>

Parameter

testSuiteCreateParams: TestSuiteCreateParams[]

Parameter für die Suiteerstellung

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, in dem anforderungsbasierte Suites erstellt werden müssen.

parentSuiteId: number

ID der übergeordneten Suite, unter der anforderungsbasierte Suites erstellt werden

Gibt zurück

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Erstellen Sie eine Testkonfiguration.

function createTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string): Promise<TestConfiguration>

Parameter

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

Erstellen Sie einen Testplan.

function createTestPlan(testPlanCreateParams: TestPlanCreateParams, project: string): Promise<TestPlan>

Parameter

testPlanCreateParams: TestPlanCreateParams

Ein testPlanCreateParams-Objekt. TestPlanCreateParams

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestPlan>

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

Erstellen Sie einen Testplan mit Testfällen, indem Sie einen Auftrag in die Warteschlange einreihen.

function createTestPlanWithTestCases(creationParams: TestPlanWithTestCasesCreateParams, project: string): Promise<boolean>

Parameter

creationParams: TestPlanWithTestCasesCreateParams

Parameter für das Anlegen des Testplans und der Testfälle.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<boolean>

createTestSuite(TestSuiteCreateParams, string, number)

Erstellen Sie Testsuite.

function createTestSuite(testSuiteCreateParams: TestSuiteCreateParams, project: string, planId: number): Promise<TestSuite>

Parameter

testSuiteCreateParams: TestSuiteCreateParams

Parameter für die Suiteerstellung

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, der die Suites enthält.

Gibt zurück

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

Erstellen Sie eine Testvariable.

function createTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string): Promise<TestVariable>

Parameter

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<TestVariable>

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>

deleteTestConfguration(string, number)

Löschen Sie eine Testkonfiguration anhand ihrer ID.

function deleteTestConfguration(project: string, testConfiguartionId: number): Promise<void>

Parameter

project: string

Projekt-ID oder Projektname

testConfiguartionId: number

ID der zu löschenden Testkonfiguration.

Gibt zurück

Promise<void>

deleteTestPlan(string, number)

Löschen eines Testplans.

function deleteTestPlan(project: string, planId: number): Promise<void>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des zu löschenden Testplans.

Gibt zurück

Promise<void>

deleteTestSuite(string, number, number)

Testsuite löschen.

function deleteTestSuite(project: string, planId: number, suiteId: number): Promise<void>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, der die Suite enthält.

suiteId: number

ID der zu löschenden Testsuite.

Gibt zurück

Promise<void>

deleteTestVariable(string, number)

Löschen Sie eine Testvariable anhand ihrer ID.

function deleteTestVariable(project: string, testVariableId: number): Promise<void>

Parameter

project: string

Projekt-ID oder Projektname

testVariableId: number

ID der zu löschenden Testvariable.

Gibt zurück

Promise<void>

exportTestCases(ExportTestCaseParams, string)

Exportiert eine Reihe von Testfällen aus einer Suite in eine Datei. Derzeit unterstützte Formate: xlsx

function exportTestCases(exportTestCaseRequestBody: ExportTestCaseParams, project: string): Promise<ArrayBuffer>

Parameter

exportTestCaseRequestBody: ExportTestCaseParams

Ein ExportTestCaseParams-Objekt. ExportTestCaseParams

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArrayBuffer>

getCloneInformation(string, number)

Abrufen von Kloninformationen.

function getCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestPlanOperationInformation>

Parameter

project: string

Projekt-ID oder Projektname

cloneOperationId: number

Vorgangs-ID, die zurückgegeben wird, wenn ein Klonvorgang in die Warteschlange gestellt wird

Gibt zurück

Promise<CloneTestPlanOperationInformation>

getDeletedTestPlans(string, string)

Abrufen einer Liste gelöschter Testpläne

function getDeletedTestPlans(project: string, continuationToken?: string): Promise<PagedList<TestPlan>>

Parameter

project: string

Projekt-ID oder Projektname

continuationToken: string

Wenn die Liste der zurückgegebenen Pläne nicht abgeschlossen ist, wird ein Fortsetzungstoken zum Abfragen des nächsten Plans im Antwortheader als "x-ms-continuationtoken" enthalten. Lassen Sie diesen Parameter weg, um den ersten Batch von Testplänen abzurufen.

Gibt zurück

Promise<PagedList<TestPlan>>

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Abrufen gelöschter Testsammlungen für einen Testplan.

function getDeletedTestSuitesForPlan(project: string, planId: number, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Suites angefordert werden.

expand: SuiteExpand

Fügen Sie die Details der Kindersammlungen und Tester ein.

continuationToken: string

Wenn die zurückgegebene Liste der zurückgegebenen Suites nicht abgeschlossen ist, wird ein Fortsetzungstoken zum Abfragen des nächsten Batches von Suites im Antwortheader als "x-ms-continuationtoken" enthalten. Lassen Sie diesen Parameter aus, um den ersten Batch von Testsammlungen abzurufen.

asTreeView: boolean

Wenn die zurückgegebenen Suites in einer Struktur vorhanden sein sollen.

Gibt zurück

Promise<PagedList<TestSuite>>

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Abrufen gelöschter Testsuiten innerhalb eines Projekts.

function getDeletedTestSuitesForProject(project: string, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Parameter

project: string

Projekt-ID oder Projektname

expand: SuiteExpand

Fügen Sie die Details der Kindersammlungen und Tester ein.

continuationToken: string

asTreeView: boolean

Wenn die zurückgegebenen Suites in einer Struktur vorhanden sein sollen.

Gibt zurück

Promise<PagedList<TestSuite>>

getPoints(string, number, number, string, boolean, boolean)

Erhalten Sie einen bestimmten Testpunkt aus einer Suite.

function getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPoint[]>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Testpunkte angefordert werden.

suiteId: number

ID der Testsuite, für die Testpunkte angefordert werden.

pointId: string

ID des abzurufenden Testpunkts.

returnIdentityRef: boolean

Wenn dieser Wert auf "true" festgelegt ist, wird das AssignedTo-Feld in TestCaseReference als IdentityRef-Objekt zurückgegeben.

includePointDetails: boolean

Wenn dieser Wert auf "false" festgelegt ist, wird eine kleinere Nutzlast abgerufen, die nur grundlegende Details zum Testpunktobjekt enthält.

Gibt zurück

Promise<TestPoint[]>

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Abrufen aller Punkte innerhalb einer Suite basierend auf einigen Filtern

function getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<PagedList<TestPoint>>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Testpunkte angefordert werden.

suiteId: number

ID der Testsuite, für die Testpunkte angefordert werden

testPointIds: string

ID der abzurufenden Testpunkte.

testCaseId: string

Abrufen von Testpunkten für bestimmte Testfall-IDs.

continuationToken: string

Wenn die Liste der zurückgegebenen Testpunkte nicht abgeschlossen ist, wird ein Fortsetzungstoken zum Abfragen des nächsten Batches von Testpunkten im Antwortheader als "x-ms-continuationtoken" eingeschlossen. Lassen Sie diesen Parameter aus, um den ersten Batch von Testpunkten abzurufen.

returnIdentityRef: boolean

Wenn dieser Wert auf "true" festgelegt ist, wird das AssignedTo-Feld in TestCaseReference als IdentityRef-Objekt zurückgegeben.

includePointDetails: boolean

Wenn dieser Wert auf "false" festgelegt ist, wird eine kleinere Nutzlast abgerufen, die nur grundlegende Details zum Testpunktobjekt enthält.

isRecursive: boolean

Wenn dieser Wert auf "true" festgelegt ist, werden auch Testpunkte abgerufen, die zu untergeordneten Suites rekursiv gehören.

Gibt zurück

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Abrufen von Kloninformationen.

function getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestSuiteOperationInformation>

Parameter

project: string

Projekt-ID oder Projektname

cloneOperationId: number

Vorgangs-ID, die zurückgegeben wird, wenn ein Klonvorgang in die Warteschlange gestellt wird

Gibt zurück

Promise<CloneTestSuiteOperationInformation>

getSuiteEntries(string, number, SuiteEntryTypes)

Rufen Sie eine Liste der Testsuiteeinträge in der Testsuite ab.

function getSuiteEntries(project: string, suiteId: number, suiteEntryType?: SuiteEntryTypes): Promise<SuiteEntry[]>

Parameter

project: string

Projekt-ID oder Projektname

suiteId: number

ID der übergeordneten Suite.

suiteEntryType: SuiteEntryTypes

Gibt zurück

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

Suchen Sie die Liste aller Testsuiten, in denen ein bestimmter Testfall vorhanden ist. Dies ist hilfreich, wenn Sie herausfinden müssen, welche Testsuiten einen Testfall verwenden, wenn Sie Änderungen an einem Testfall vornehmen müssen.

function getSuitesByTestCaseId(testCaseId: number): Promise<TestSuite[]>

Parameter

testCaseId: number

ID des Testfalls, für den Suites abgerufen werden müssen.

Gibt zurück

Promise<TestSuite[]>

getTestCase(string, number, number, string, string, boolean)

Erhalten Sie einen bestimmten Testfall aus einer Suite.

function getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestCase[]>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Testfälle angefordert werden.

suiteId: number

ID der Testsuite, für die Testfälle angefordert werden.

testCaseId: string

Testfall-ID, die abgerufen werden soll.

witFields: string

Dient zum Abrufen der Liste von witFields.

returnIdentityRef: boolean

Wenn dieser Wert auf "true" festgelegt ist, werden alle Identitätsfelder wie AssignedTo, ActivatedBy usw. als IdentityRef-Objekte zurückgegeben. Wenn dieser Wert auf "false" festgelegt ist, werden diese Felder als eindeutige Namen im Zeichenfolgenformat zurückgegeben. Dies ist standardmäßig "false".

Gibt zurück

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

Abrufen von Kloninformationen.

function getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestCaseOperationInformation>

Parameter

project: string

Projekt-ID oder Projektname

cloneOperationId: number

Vorgangs-ID, die zurückgegeben wird, wenn ein Klonvorgang in die Warteschlange gestellt wird

Gibt zurück

Promise<CloneTestCaseOperationInformation>

getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)

Get Test Case List return those test cases which have all the configuration IDs as mentioned in the optional parameter. Wenn Konfigurations-IDs null sind, werden alle Testfälle zurückgegeben.

function getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: ExcludeFlags, isRecursive?: boolean): Promise<PagedList<TestCase>>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Testfälle angefordert werden.

suiteId: number

ID der Testsuite, für die Testfälle angefordert werden.

testIds: string

Testfall-IDs, die abgerufen werden sollen.

configurationIds: string

Abrufen von Testfällen, die alle angegebenen Konfigurations-IDs enthalten.

witFields: string

Dient zum Abrufen der Liste von witFields.

continuationToken: string

Wenn die Liste der zurückgegebenen Testfälle nicht abgeschlossen ist, wird ein Fortsetzungstoken zum Abfragen des nächsten Batches von Testfällen im Antwortheader als "x-ms-continuationtoken" enthalten. Lassen Sie diesen Parameter aus, um den ersten Batch von Testfällen abzurufen.

returnIdentityRef: boolean

expand: boolean

Wenn dieser Wert auf "false" festgelegt ist, wird eine kleinere Nutzlast abgerufen, die nur grundlegende Details zum Testfallobjekt der Suite enthält.

excludeFlags: ExcludeFlags

Kennzeichnen, um verschiedene Werte aus der Nutzlast auszuschließen. Um z. B. Punktzuweisungen zu entfernen, schließen "exclude = 1" aus. Um zusätzliche Informationen (Links, Testplan, Testsuite) zu entfernen, schließen Sie den Pass = 2 aus. Um zusätzliche Informationen und Punktzuordnungen zu entfernen, schließen Sie aus : 3 (1 + 2).

isRecursive: boolean

Gibt zurück

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

Abrufen einer Testkonfiguration

function getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestConfiguration>

Parameter

project: string

Projekt-ID oder Projektname

testConfigurationId: number

ID der abzurufenden Testkonfiguration.

Gibt zurück

Promise<TestConfiguration>

getTestConfigurations(string, string)

Dient zum Abrufen einer Liste von Testkonfigurationen.

function getTestConfigurations(project: string, continuationToken?: string): Promise<PagedList<TestConfiguration>>

Parameter

project: string

Projekt-ID oder Projektname

continuationToken: string

Wenn die Liste der zurückgegebenen Konfigurationen nicht abgeschlossen ist, wird ein Fortsetzungstoken zum Abfragen des nächsten Batches von Konfigurationen im Antwortheader als "x-ms-continuationtoken" enthalten. Lassen Sie diesen Parameter aus, um den ersten Batch von Testkonfigurationen abzurufen.

Gibt zurück

Promise<PagedList<TestConfiguration>>

getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)

function getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestEntityTypes): Promise<TestEntityCount[]>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

states: string

outcome: UserFriendlyTestOutcome

configurations: string

testers: string

assignedTo: string

entity: TestEntityTypes

Gibt zurück

Promise<TestEntityCount[]>

getTestPlanById(string, number)

Abrufen eines Testplans nach ID.

function getTestPlanById(project: string, planId: number): Promise<TestPlan>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des abzurufenden Testplans.

Gibt zurück

Promise<TestPlan>

getTestPlans(string, string, string, boolean, boolean)

Abrufen einer Liste von Testplänen

function getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<PagedList<TestPlan>>

Parameter

project: string

Projekt-ID oder Projektname

owner: string

Filtern nach Testplan nach Besitzer-ID oder Name

continuationToken: string

includePlanDetails: boolean

Abrufen aller Eigenschaften des Testplans

filterActivePlans: boolean

Abrufen nur der aktiven Pläne

Gibt zurück

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

Abrufen der Testsuite nach Suite-ID.

function getTestSuiteById(project: string, planId: number, suiteId: number, expand?: SuiteExpand): Promise<TestSuite>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, der die Suites enthält.

suiteId: number

ID der abzurufenden Suite.

expand: SuiteExpand

Details zu den Kindersuiten und Testern einschließen

Gibt zurück

Promise<TestSuite>

getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Abrufen von Testsuiten für den Plan.

function getTestSuitesForPlan(project: string, planId: number, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Suites angefordert werden.

expand: SuiteExpand

Fügen Sie die Details der Kindersammlungen und Tester ein.

continuationToken: string

asTreeView: boolean

Wenn die zurückgegebenen Suites in einer Struktur vorhanden sein sollen.

Gibt zurück

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Rufen Sie eine Testvariable anhand ihrer ID ab.

function getTestVariableById(project: string, testVariableId: number): Promise<TestVariable>

Parameter

project: string

Projekt-ID oder Projektname

testVariableId: number

ID der abzurufenden Testvariable.

Gibt zurück

Promise<TestVariable>

getTestVariables(string, string)

Dient zum Abrufen einer Liste von Testvariablen.

function getTestVariables(project: string, continuationToken?: string): Promise<PagedList<TestVariable>>

Parameter

project: string

Projekt-ID oder Projektname

continuationToken: string

Wenn die Liste der zurückgegebenen Variablen nicht abgeschlossen ist, wird ein Fortsetzungstoken zum Abfragen des nächsten Batches von Variablen im Antwortheader als "x-ms-continuationtoken" eingeschlossen. Lassen Sie diesen Parameter aus, um den ersten Batch von Testvariablen abzurufen.

Gibt zurück

Promise<PagedList<TestVariable>>

removeTestCasesFromSuite(string, number, number, string)

Entfernt Testfälle aus einer Suite basierend auf der Liste der bereitgestellten Testfall-IDs.

function removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, aus dem Testfälle entfernt werden sollen.

suiteId: number

ID der Testsuite, aus der Testfälle entfernt werden sollen.

testCaseIds: string

Testfall-IDs, die entfernt werden sollen.

Gibt zurück

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

Entfernt Testfälle aus einer Suite basierend auf der Liste der bereitgestellten Testfall-IDs. Diese API kann verwendet werden, um eine größere Anzahl von Testfällen zu entfernen.

function removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>

Parameter

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, aus dem Testfälle entfernt werden sollen.

suiteId: number

ID der Testsuite, aus der Testfälle entfernt werden sollen.

testIds: string

Trennzeichentrennte Zeichenfolge der zu entfernenden Testfall-IDs.

Gibt zurück

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

Neuanordnen von Testsuiteeinträgen in der Testsuite.

function reorderSuiteEntries(suiteEntries: SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<SuiteEntry[]>

Parameter

suiteEntries: SuiteEntryUpdateParams[]

Liste der SuiteEntry zum Neuanordnen.

project: string

Projekt-ID oder Projektname

suiteId: number

ID der übergeordneten Testsuite.

Gibt zurück

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

Stellt den gelöschten Testplan wieder her

function restoreDeletedTestPlan(restoreModel: TestPlanAndSuiteRestoreModel, project: string, planId: number): Promise<void>

Parameter

restoreModel: TestPlanAndSuiteRestoreModel

Das Modell, das die Wiederherstellungsinformationen enthält

project: string

Projekt-ID oder Projektname

planId: number

Die ID des wiederherzustellenden Testplans

Gibt zurück

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

Stellt die gelöschte Testsuite wieder her

function restoreDeletedTestSuite(payload: TestPlanAndSuiteRestoreModel, project: string, suiteId: number): Promise<void>

Parameter

payload: TestPlanAndSuiteRestoreModel

Das Modell, das die Wiederherstellungsinformationen enthält

project: string

Projekt-ID oder Projektname

suiteId: number

Die ID der zu wiederherstellenden Testsuite

Gibt zurück

Promise<void>

updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Aktualisieren der Konfigurationen für Testfälle

function updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Parameter

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Ein SuiteTestCaseCreateUpdateParameters-Objekt.

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, auf den Testfälle aktualisiert werden sollen.

suiteId: number

ID der Testsuite, auf die Testfälle aktualisiert werden sollen.

Gibt zurück

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

Aktualisieren Sie eine Testkonfiguration anhand ihrer ID.

function updateTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string, testConfiguartionId: number): Promise<TestConfiguration>

Parameter

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

Projekt-ID oder Projektname

testConfiguartionId: number

ID der zu aktualisierenden Testkonfiguration.

Gibt zurück

Promise<TestConfiguration>

updateTestPlan(TestPlanUpdateParams, string, number)

Aktualisieren eines Testplans.

function updateTestPlan(testPlanUpdateParams: TestPlanUpdateParams, project: string, planId: number): Promise<TestPlan>

Parameter

testPlanUpdateParams: TestPlanUpdateParams

Ein testPlanUpdateParams-Objekt. TestPlanUpdateParams

project: string

Projekt-ID oder Projektname

planId: number

ID des zu aktualisierenden Testplans.

Gibt zurück

Promise<TestPlan>

updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)

Testpunkte aktualisieren. Dies wird verwendet, um den Testpunkt auf aktiv zurückzusetzen, das Ergebnis eines Testpunkts zu aktualisieren oder den Tester eines Testpunkts zu aktualisieren.

function updateTestPoints(testPointUpdateParams: TestPointUpdateParams[], project: string, planId: number, suiteId: number, includePointDetails?: boolean, returnIdentityRef?: boolean): Promise<TestPoint[]>

Parameter

testPointUpdateParams: TestPointUpdateParams[]

Ein TestPointUpdateParams-Objekt.

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, für den Testpunkte angefordert werden.

suiteId: number

ID der Testsuite, für die Testpunkte angefordert werden.

includePointDetails: boolean

Wenn dieser Wert auf "false" festgelegt ist, wird eine kleinere Nutzlast abgerufen, die nur grundlegende Details zum Testpunktobjekt enthält.

returnIdentityRef: boolean

Wenn dieser Wert auf "true" festgelegt ist, wird das AssignedTo-Feld in TestCaseReference als IdentityRef-Objekt zurückgegeben.

Gibt zurück

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

Aktualisieren sie die Testsuite.

function updateTestSuite(testSuiteUpdateParams: TestSuiteUpdateParams, project: string, planId: number, suiteId: number): Promise<TestSuite>

Parameter

testSuiteUpdateParams: TestSuiteUpdateParams

Parameter für die Suite-Updation

project: string

Projekt-ID oder Projektname

planId: number

ID des Testplans, der die Suites enthält.

suiteId: number

ID der übergeordneten Suite.

Gibt zurück

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

Aktualisieren Sie eine Testvariable anhand ihrer ID.

function updateTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string, testVariableId: number): Promise<TestVariable>

Parameter

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

Projekt-ID oder Projektname

testVariableId: number

ID der zu aktualisierenden Testvariable.

Gibt zurück

Promise<TestVariable>

Feedback

War diese Seite hilfreich?

Freigeben über

TestPlanRestClient class

Konstruktoren

Methoden

Details zum Konstruktor

TestPlanRestClient(IVssRestClientOptions)

Parameter

Details zur Methode

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Parameter

Gibt zurück

cloneTestCase(CloneTestCaseParams, string)

Parameter

Gibt zurück

cloneTestPlan(CloneTestPlanParams, string, boolean)

Parameter

Gibt zurück

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Parameter

Gibt zurück

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Parameter

Gibt zurück

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Parameter

Gibt zurück

createTestPlan(TestPlanCreateParams, string)

Parameter

Gibt zurück

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

Parameter

Gibt zurück

createTestSuite(TestSuiteCreateParams, string, number)

Parameter

Gibt zurück

createTestVariable(TestVariableCreateUpdateParameters, string)

Parameter

Gibt zurück

deleteTestCase(string, number)

Parameter

Gibt zurück

deleteTestConfguration(string, number)

Parameter

Gibt zurück

deleteTestPlan(string, number)

Parameter

Gibt zurück

deleteTestSuite(string, number, number)

Parameter

Gibt zurück

deleteTestVariable(string, number)

Parameter

Gibt zurück

exportTestCases(ExportTestCaseParams, string)

Parameter

Gibt zurück

getCloneInformation(string, number)

Parameter

Gibt zurück

getDeletedTestPlans(string, string)

Parameter

Gibt zurück

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Parameter

Gibt zurück

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Parameter

Gibt zurück

getPoints(string, number, number, string, boolean, boolean)

Parameter

Gibt zurück

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Parameter

Gibt zurück

getSuiteCloneInformation(string, number)

Parameter

Gibt zurück

getSuiteEntries(string, number, SuiteEntryTypes)

Parameter

Gibt zurück