TestPlanRestClient class

Referenz

Paket:: azure-devops-extension-api

Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).

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 des Testplans
cloneTestSuite(CloneTestSuiteParams, string, boolean)	Klonen der Testsuite
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)	Create massenanforderungenbasierte Testsammlungen.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Create eine Testkonfiguration.
createTestPlan(TestPlanCreateParams, string)	Create einen Testplan.
createTestSuite(TestSuiteCreateParams, string, number)	Create Testsuite.
createTestVariable(TestVariableCreateUpdateParameters, string)	Create 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 Sie einen Testplan.
deleteTestSuite(string, number, number)	Löschen Sie die Testsuite.
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)	Rufen Sie Kloninformationen ab.
getPoints(string, number, number, string, boolean, boolean)	Abrufen eines bestimmten Testpunkts 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)	Rufen Sie Kloninformationen ab.
getSuiteEntries(string, number, SuiteEntryTypes)	Rufen Sie eine Liste der Testsuiteeinträge in der Testsuite ab.
getSuitesByTestCaseId(number)	Suchen Sie die Liste aller Testsammlungen, in denen ein bestimmter Testfall vorhanden ist. Dies ist hilfreich, wenn Sie herausfinden müssen, welche Testsammlungen einen Testfall verwenden, wenn Sie Änderungen an einem Testfall vornehmen müssen.
getTestCase(string, number, number, string, string, boolean)	Rufen Sie einen bestimmten Testfall aus einer Suite ab.
getTestCaseCloneInformation(string, number)	Rufen Sie Kloninformationen ab.
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)	Get Test Case List gibt die Testfälle zurück, die über alle Konfigurations-IDs verfügen, wie im optionalen Parameter erwähnt. Wenn Konfigurations-IDs NULL sind, werden alle Testfälle zurückgegeben.
getTestConfigurationById(string, number)	Abrufen einer Testkonfiguration
getTestConfigurations(string, string)	Rufen Sie eine Liste der Testkonfigurationen ab.
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 mit Testplänen
getTestSuiteById(string, number, number, SuiteExpand)	Abrufen der Testsuite nach Suite-ID.
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Abrufen von Testsammlungen für den Plan.
getTestVariableById(string, number)	Rufen Sie eine Testvariable nach ihrer ID ab.
getTestVariables(string, string)	Rufen Sie eine Liste der Testvariablen ab.
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)	Ordnen Sie Testsuiteeinträge in der Testsuite neu an.
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	Wiederherstellen eines gelöschten Testplans
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	Wiederherstellen gelöschter Testsuite
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 Sie einen Testplan.
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	Aktualisieren sie Testpunkte. 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 um ihre 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, 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 des Testplans

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

Klont auch alle zugeordneten Testfälle

Gibt zurück

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Klonen der Testsuite

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

Parameter

cloneRequestBody: CloneTestSuiteParams

Suite Clone Request Body detail TestSuiteCloneRequest

project: string

Projekt-ID oder Projektname

deepClone: boolean

Klont auch alle zugeordneten Testfälle

Gibt zurück

Promise<CloneTestSuiteOperationInformation>

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

Create massenanforderungenbasierte Testsammlungen.

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 Suiten erstellt werden

Gibt zurück

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

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

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

createTestSuite(TestSuiteCreateParams, string, number)

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

Create 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 Sie einen Testplan.

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)

Löschen Sie die Testsuite.

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

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)

Rufen Sie Kloninformationen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

cloneOperationId: number

Vorgangs-ID, die zurückgegeben wird, wenn wir einen Klonvorgang in die Warteschlange stellen

Gibt zurück

Promise<CloneTestPlanOperationInformation>

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

Abrufen eines bestimmten Testpunkts 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 auf true festgelegt ist, gibt das Feld AssignedTo in TestCaseReference als IdentityRef-Objekt zurück.

includePointDetails: boolean

Wenn auf false festgelegt, 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 vollständig ist, ist ein Fortsetzungstoken zum Abfragen des nächsten Batches von Testpunkten als "x-ms-continuationtoken" im Antwortheader enthalten. Lassen Sie diesen Parameter weg, um den ersten Batch von Testpunkten abzurufen.

returnIdentityRef: boolean

Wenn auf true festgelegt ist, gibt das Feld AssignedTo in TestCaseReference als IdentityRef-Objekt zurück.

includePointDetails: boolean

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

isRecursive: boolean

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

Gibt zurück

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Rufen Sie Kloninformationen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

cloneOperationId: number

Vorgangs-ID, die zurückgegeben wird, wenn wir einen Klonvorgang in die Warteschlange stellen

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 Testsammlungen, in denen ein bestimmter Testfall vorhanden ist. Dies ist hilfreich, wenn Sie herausfinden müssen, welche Testsammlungen 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)

Rufen Sie einen bestimmten Testfall aus einer Suite ab.

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

Rufen Sie die Liste der witFields ab.

returnIdentityRef: boolean

Wenn auf true festgelegt, werden alle Identitätsfelder wie AssignedTo, ActivatedBy usw. als IdentityRef-Objekte zurückgegeben. Wenn 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)

Rufen Sie Kloninformationen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

cloneOperationId: number

Vorgangs-ID, die zurückgegeben wird, wenn wir einen Klonvorgang in die Warteschlange stellen

Gibt zurück

Promise<CloneTestCaseOperationInformation>

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

Get Test Case List gibt die Testfälle zurück, die über alle Konfigurations-IDs verfügen, wie im optionalen Parameter erwähnt. 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

Ruft Testfälle ab, die alle angegebenen Konfigurations-IDs enthält.

witFields: string

Rufen Sie die Liste der witFields ab.

continuationToken: string

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

returnIdentityRef: boolean

expand: boolean

Wird auf false festgelegt, 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 beispielsweise Punktzuweisungen zu entfernen, übergeben Sie exclude = 1. Um zusätzliche Informationen (Links, Testplan , Testsuite) zu entfernen, pass exclude = 2. Um zusätzliche Informationen und Punktzuweisungen zu entfernen, übergeben Sie exclude = 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)

Rufen Sie eine Liste der Testkonfigurationen ab.

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 vollständig ist, ist ein Fortsetzungstoken zum Abfragen des nächsten Konfigurationsbatches als "x-ms-continuationtoken" im Antwortheader enthalten. Lassen Sie diesen Parameter weg, um den ersten Batch mit 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 mit 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

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

includePlanDetails: boolean

Abrufen aller Eigenschaften des Testplans

filterActivePlans: boolean

Nur die aktiven Pläne abrufen

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 zu erhaltenden Suite.

expand: SuiteExpand

Einschließen der Kindersammlungen und Testerdetails

Gibt zurück

Promise<TestSuite>

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

Abrufen von Testsammlungen 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 Suiten angefordert werden.

expand: SuiteExpand

Fügen Sie die Details zu den Untergeordneten Suiten und Testern ein.

continuationToken: string

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

asTreeView: boolean

Wenn sich die zurückgegebenen Suiten in einer Struktur befinden sollen.

Gibt zurück

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Rufen Sie eine Testvariable nach ihrer ID ab.

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

Parameter

project: string

Projekt-ID oder Projektname

testVariableId: number

ID der abzurufenden Testvariablen.

Gibt zurück

Promise<TestVariable>

getTestVariables(string, string)

Rufen Sie eine Liste der Testvariablen ab.

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 vollständig ist, ist ein Fortsetzungstoken zum Abfragen des nächsten Batches von Variablen als "x-ms-continuationtoken" im Antwortheader enthalten. Lassen Sie diesen Parameter weg, um den ersten Batch mit 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

Durch Trennzeichen getrennte Zeichenfolge der zu entfernenden Testfall-IDs.

Gibt zurück

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

Ordnen Sie Testsuiteeinträge in der Testsuite neu an.

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

Parameter

suiteEntries: SuiteEntryUpdateParams[]

Liste von SuiteEntry zum Neuanordnen.

project: string

Projekt-ID oder Projektname

suiteId: number

ID der übergeordneten Testsuite.

Gibt zurück

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

Wiederherstellen eines gelöschten Testplans

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)

Wiederherstellen gelöschter Testsuite

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 wiederherzustellenden 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 Sie einen Testplan.

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)

Aktualisieren sie Testpunkte. 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 auf false festgelegt, wird eine kleinere Nutzlast abgerufen, die nur grundlegende Details zum Testpunktobjekt enthält.

returnIdentityRef: boolean

Wenn auf true festgelegt ist, gibt das Feld AssignedTo in TestCaseReference als IdentityRef-Objekt zurück.

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

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 um ihre 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 Testvariablen.

Gibt zurück

Promise<TestVariable>

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

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

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

getSuitesByTestCaseId(number)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

getTestCaseCloneInformation(string, number)

Parameter

Gibt zurück

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

Parameter

Gibt zurück