次の方法で共有


TestPlanRestClient class

VSS REST API への要求を行うために使用する (派生する) 基本クラス

Extends

コンストラクター

TestPlanRestClient(IVssRestClientOptions)

メソッド

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

指定した構成のスイートにテスト ケースを追加する

cloneTestCase(CloneTestCaseParams, string)
cloneTestPlan(CloneTestPlanParams, string, boolean)

テスト計画の複製

cloneTestSuite(CloneTestSuiteParams, string, boolean)

テスト スイートの複製

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

一括要件ベースのテスト スイートを作成します。

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

テスト構成を作成します。

createTestPlan(TestPlanCreateParams, string)

テスト計画を作成します。

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

ジョブをキューに入れて、テスト ケースを含むテスト計画を作成します。

createTestSuite(TestSuiteCreateParams, string, number)

テスト スイートを作成します。

createTestVariable(TestVariableCreateUpdateParameters, string)

テスト変数を作成します。

deleteTestCase(string, number)

テスト ケースを削除します。

deleteTestConfguration(string, number)

テスト構成を ID で削除します。

deleteTestPlan(string, number)

テスト計画を削除します。

deleteTestSuite(string, number, number)

テスト スイートを削除します。

deleteTestVariable(string, number)

テスト変数を ID で削除します。

exportTestCases(ExportTestCaseParams, string)

一連のテスト ケースをスイートからファイルにエクスポートします。 現在サポートされている形式: xlsx

getCloneInformation(string, number)

クローン情報を取得します。

getDeletedTestPlans(string, string)

削除されたテスト 計画の一覧を取得する

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

テスト計画の削除されたテスト スイートを取得します。

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

プロジェクト内で削除されたテストスイートを取得します。

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

スイートから特定のテスト ポイントを取得します。

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

一部のフィルターに基づいてスイート内のすべてのポイントを取得する

getSuiteCloneInformation(string, number)

クローン情報を取得します。

getSuiteEntries(string, number, SuiteEntryTypes)

テスト スイート内のテスト スイート エントリの一覧を取得します。

getSuitesByTestCaseId(number)

特定のテスト ケースが存在するすべてのテスト スイートの一覧を見つけます。 これは、テスト ケースに変更を加える必要がある場合に、テスト ケースを使用しているテスト スイートを確認する必要がある場合に役立ちます。

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

スイートから特定のテスト ケースを取得します。

getTestCaseCloneInformation(string, number)

クローン情報を取得します。

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

Get Test Case List は、省略可能なパラメーターで説明されているように、すべての構成 ID を持つテスト ケースを返します。 構成 ID が null の場合は、すべてのテスト ケースが返されます

getTestConfigurationById(string, number)

テスト構成を取得する

getTestConfigurations(string, string)

テスト構成の一覧を取得します。

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

ID でテスト 計画を取得します。

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

テスト計画の一覧を取得する

getTestSuiteById(string, number, number, SuiteExpand)

スイート ID でテスト スイートを取得します。

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

計画のテスト スイートを取得します。

getTestVariableById(string, number)

ID でテスト変数を取得します。

getTestVariables(string, string)

テスト変数の一覧を取得します。

removeTestCasesFromSuite(string, number, number, string)

指定されたテスト ケース ID の一覧に基づいて、スイートからテスト ケースを削除します。

removeTestCasesListFromSuite(string, number, number, string)

指定されたテスト ケース ID の一覧に基づいて、スイートからテスト ケースを削除します。 この API を使用すると、より多くのテスト ケースを削除できます。

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

テスト スイートのテスト スイート エントリを並べ替えます。

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

削除されたテスト 計画を復元します

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

削除されたテスト スイートを復元します

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

テスト ケースの構成を更新する

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

テスト構成を ID で更新します。

updateTestPlan(TestPlanUpdateParams, string, number)

テスト計画を更新します。

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

テスト ポイントを更新します。 これは、テスト ポイントをアクティブにリセットしたり、テスト ポイントの結果を更新したり、テスト ポイントのテスト担当者を更新したりするために使用されます。

updateTestSuite(TestSuiteUpdateParams, string, number, number)

テスト スイートを更新します。

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

テスト変数を ID で更新します。

コンストラクターの詳細

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

パラメーター

メソッドの詳細

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

指定した構成のスイートにテスト ケースを追加する

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

パラメーター

suiteTestCaseCreateUpdateParameters

SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters オブジェクト。

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ケースを追加するテスト計画の ID。

suiteId

number

テスト ケースを追加するテスト スイートの ID。

戻り値

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

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

パラメーター

cloneRequestBody
CloneTestCaseParams
project

string

プロジェクト ID またはプロジェクト名

戻り値

cloneTestPlan(CloneTestPlanParams, string, boolean)

テスト計画の複製

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

パラメーター

cloneRequestBody
CloneTestPlanParams

プラン クローン要求本文の詳細 TestPlanCloneRequest

project

string

プロジェクト ID またはプロジェクト名

deepClone

boolean

関連するすべてのテスト ケースも複製します

戻り値

cloneTestSuite(CloneTestSuiteParams, string, boolean)

テスト スイートの複製

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

パラメーター

cloneRequestBody
CloneTestSuiteParams

スイート クローン要求本文の詳細 TestSuiteCloneRequest

project

string

プロジェクト ID またはプロジェクト名

deepClone

boolean

関連するすべてのテスト ケースも複製します

戻り値

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

一括要件ベースのテスト スイートを作成します。

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

パラメーター

testSuiteCreateParams

TestSuiteCreateParams[]

スイート作成のパラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

要件ベースのスイートを作成する必要があるテスト 計画の ID。

parentSuiteId

number

要件ベースのスイートが作成される親スイートの ID

戻り値

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

テスト構成を作成します。

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

パラメーター

testConfigurationCreateUpdateParameters
TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project

string

プロジェクト ID またはプロジェクト名

戻り値

createTestPlan(TestPlanCreateParams, string)

テスト計画を作成します。

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

パラメーター

testPlanCreateParams
TestPlanCreateParams

testPlanCreateParams オブジェクト。TestPlanCreateParams

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestPlan>

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

ジョブをキューに入れて、テスト ケースを含むテスト計画を作成します。

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

パラメーター

creationParams
TestPlanWithTestCasesCreateParams

テスト計画とテストケースを作成するためのパラメーター。

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<boolean>

createTestSuite(TestSuiteCreateParams, string, number)

テスト スイートを作成します。

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

パラメーター

testSuiteCreateParams
TestSuiteCreateParams

スイート作成のパラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

スイートを含むテスト 計画の ID。

戻り値

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

テスト変数を作成します。

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

パラメーター

testVariableCreateUpdateParameters
TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestVariable>

deleteTestCase(string, number)

テスト ケースを削除します。

function deleteTestCase(project: string, testCaseId: number): Promise<void>

パラメーター

project

string

プロジェクト ID またはプロジェクト名

testCaseId

number

削除するテスト ケースの ID。

戻り値

Promise<void>

deleteTestConfguration(string, number)

テスト構成を ID で削除します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

testConfiguartionId

number

削除するテスト構成の ID。

戻り値

Promise<void>

deleteTestPlan(string, number)

テスト計画を削除します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

削除するテスト 計画の ID。

戻り値

Promise<void>

deleteTestSuite(string, number, number)

テスト スイートを削除します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

スイートを含むテスト 計画の ID。

suiteId

number

削除するテスト スイートの ID。

戻り値

Promise<void>

deleteTestVariable(string, number)

テスト変数を ID で削除します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

testVariableId

number

削除するテスト変数の ID。

戻り値

Promise<void>

exportTestCases(ExportTestCaseParams, string)

一連のテスト ケースをスイートからファイルにエクスポートします。 現在サポートされている形式: xlsx

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

パラメーター

exportTestCaseRequestBody
ExportTestCaseParams

ExportTestCaseParams オブジェクト。ExportTestCaseParams

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<ArrayBuffer>

getCloneInformation(string, number)

クローン情報を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

cloneOperationId

number

複製操作をキューに入れたときに返される操作 ID

戻り値

getDeletedTestPlans(string, string)

削除されたテスト 計画の一覧を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

continuationToken

string

返されるプランの一覧が完全でない場合は、プランの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト 計画の最初のバッチを取得するには、このパラメーターを省略します。

戻り値

Promise<PagedList<TestPlan>>

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

テスト計画の削除されたテスト スイートを取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

スイートが要求されるテスト 計画の ID。

expand
SuiteExpand

子供スイートとテスターの詳細を含めます。

continuationToken

string

返されるスイートの一覧が完全でない場合は、スイートの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト スイートの最初のバッチを取得するには、このパラメーターを省略します。

asTreeView

boolean

返されるスイートがツリー構造である必要がある場合。

戻り値

Promise<PagedList<TestSuite>>

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

プロジェクト内で削除されたテストスイートを取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

expand
SuiteExpand

子供スイートとテスターの詳細を含めます。

continuationToken

string

返されるスイートの一覧が完全でない場合は、スイートの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト スイートの最初のバッチを取得するには、このパラメーターを省略します。

asTreeView

boolean

返されるスイートがツリー構造である必要がある場合。

戻り値

Promise<PagedList<TestSuite>>

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

スイートから特定のテスト ポイントを取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ポイントが要求されるテスト 計画の ID。

suiteId

number

テスト ポイントが要求されるテスト スイートの ID。

pointId

string

フェッチするテスト ポイントの ID。

returnIdentityRef

boolean

true に設定すると、TestCaseReference の AssignedTo フィールドが IdentityRef オブジェクトとして返されます。

includePointDetails

boolean

false に設定すると、テスト ポイント オブジェクトに関する基本的な詳細のみを含む小さなペイロードが取得されます

戻り値

Promise<TestPoint[]>

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

一部のフィルターに基づいてスイート内のすべてのポイントを取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ポイントが要求されるテスト 計画の ID。

suiteId

number

テスト ポイントが要求されるテスト スイートの ID

testPointIds

string

フェッチするテスト ポイントの ID。

testCaseId

string

特定のテスト ケース ID のテスト ポイントを取得します。

continuationToken

string

返されたテスト ポイントの一覧が完全でない場合は、テスト ポイントの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト ポイントの最初のバッチを取得するには、このパラメーターを省略します。

returnIdentityRef

boolean

true に設定すると、TestCaseReference の AssignedTo フィールドが IdentityRef オブジェクトとして返されます。

includePointDetails

boolean

false に設定すると、テスト ポイント オブジェクトに関する基本的な詳細のみを含む小さなペイロードが取得されます

isRecursive

boolean

true に設定すると、子スイートに属するテスト ポイントも再帰的にフェッチされます。

戻り値

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

クローン情報を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

cloneOperationId

number

複製操作をキューに入れたときに返される操作 ID

戻り値

getSuiteEntries(string, number, SuiteEntryTypes)

テスト スイート内のテスト スイート エントリの一覧を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

suiteId

number

親スイートの ID。

suiteEntryType
SuiteEntryTypes

戻り値

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

特定のテスト ケースが存在するすべてのテスト スイートの一覧を見つけます。 これは、テスト ケースに変更を加える必要がある場合に、テスト ケースを使用しているテスト スイートを確認する必要がある場合に役立ちます。

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

パラメーター

testCaseId

number

スイートをフェッチする必要があるテスト ケースの ID。

戻り値

Promise<TestSuite[]>

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

スイートから特定のテスト ケースを取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ケースが要求されるテスト 計画の ID。

suiteId

number

テスト ケースが要求されるテスト スイートの ID。

testCaseId

string

フェッチするテスト ケース ID。

witFields

string

witFields の一覧を取得します。

returnIdentityRef

boolean

true に設定すると、AssignedTo、ActivatedBy などのすべての ID フィールドが IdentityRef オブジェクトとして返されます。 false に設定すると、これらのフィールドは文字列形式で一意の名前として返されます。 これは既定では false です。

戻り値

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

クローン情報を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

cloneOperationId

number

複製操作をキューに入れたときに返される操作 ID

戻り値

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

Get Test Case List は、省略可能なパラメーターで説明されているように、すべての構成 ID を持つテスト ケースを返します。 構成 ID が null の場合は、すべてのテスト ケースが返されます

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ケースが要求されるテスト 計画の ID。

suiteId

number

テスト ケースが要求されるテスト スイートの ID。

testIds

string

フェッチするテスト ケース ID。

configurationIds

string

指定されたすべての構成 ID を含むテスト ケースをフェッチします。

witFields

string

witFields の一覧を取得します。

continuationToken

string

返されるテスト ケースの一覧が完全でない場合は、テスト ケースの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト ケースの最初のバッチを取得するには、このパラメーターを省略します。

returnIdentityRef

boolean

true に設定すると、AssignedTo、ActivatedBy などのすべての ID フィールドが IdentityRef オブジェクトとして返されます。 false に設定すると、これらのフィールドは文字列形式で一意の名前として返されます。 これは既定では false です。

expand

boolean

false に設定すると、スイート のテスト ケース オブジェクトに関する基本的な詳細のみを含む小さなペイロードが取得されます

excludeFlags
ExcludeFlags

ペイロードからさまざまな値を除外するフラグ。 たとえば、ポイントの割り当てを削除するには、除外 = 1 を渡します。 追加情報 (リンク、テスト 計画、テスト スイート) を削除するには、合格除外 = 2。 余分な情報とポイントの割り当ての両方を削除するには、除外 = 3 (1 + 2) を渡します。

isRecursive

boolean

戻り値

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

テスト構成を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

testConfigurationId

number

取得するテスト構成の ID。

戻り値

getTestConfigurations(string, string)

テスト構成の一覧を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

continuationToken

string

返される構成の一覧が完全でない場合は、構成の次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト構成の最初のバッチを取得するには、このパラメーターを省略します。

戻り値

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

states

string

configurations

string

testers

string

assignedTo

string

戻り値

Promise<TestEntityCount[]>

getTestPlanById(string, number)

ID でテスト 計画を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

取得するテスト 計画の ID。

戻り値

Promise<TestPlan>

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

テスト計画の一覧を取得する

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

owner

string

所有者 ID または名前でテスト 計画をフィルター処理する

continuationToken

string

返されるプランの一覧が完全でない場合は、プランの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト 計画の最初のバッチを取得するには、このパラメーターを省略します。

includePlanDetails

boolean

テスト計画のすべてのプロパティを取得する

filterActivePlans

boolean

アクティブなプランのみを取得する

戻り値

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

スイート ID でテスト スイートを取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

スイートを含むテスト 計画の ID。

suiteId

number

取得するスイートの ID。

expand
SuiteExpand

子供スイートとテスターの詳細を含める

戻り値

Promise<TestSuite>

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

計画のテスト スイートを取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

スイートが要求されるテスト 計画の ID。

expand
SuiteExpand

子供スイートとテスターの詳細を含めます。

continuationToken

string

返されるスイートの一覧が完全でない場合は、スイートの次のバッチを照会する継続トークンが応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト スイートの最初のバッチを取得するには、このパラメーターを省略します。

asTreeView

boolean

返されるスイートがツリー構造である必要がある場合。

戻り値

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

ID でテスト変数を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

testVariableId

number

取得するテスト変数の ID。

戻り値

Promise<TestVariable>

getTestVariables(string, string)

テスト変数の一覧を取得します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

continuationToken

string

返される変数の一覧が完全でない場合、変数の次のバッチを照会する継続トークンは、応答ヘッダーに "x-ms-continuationtoken" として含まれます。 テスト変数の最初のバッチを取得するには、このパラメーターを省略します。

戻り値

removeTestCasesFromSuite(string, number, number, string)

指定されたテスト ケース ID の一覧に基づいて、スイートからテスト ケースを削除します。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ケースを削除するテスト 計画の ID。

suiteId

number

テスト ケースを削除するテスト スイートの ID。

testCaseIds

string

削除するテスト ケース ID。

戻り値

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

指定されたテスト ケース ID の一覧に基づいて、スイートからテスト ケースを削除します。 この API を使用すると、より多くのテスト ケースを削除できます。

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

パラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ケースを削除するテスト 計画の ID。

suiteId

number

テスト ケースを削除するテスト スイートの ID。

testIds

string

削除するテスト ケース ID のコンマ区切り文字列。

戻り値

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

テスト スイートのテスト スイート エントリを並べ替えます。

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

パラメーター

suiteEntries

SuiteEntryUpdateParams[]

並べ替える SuiteEntry の一覧。

project

string

プロジェクト ID またはプロジェクト名

suiteId

number

親テスト スイートの ID。

戻り値

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

削除されたテスト 計画を復元します

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

パラメーター

restoreModel
TestPlanAndSuiteRestoreModel

復元情報を含むモデル

project

string

プロジェクト ID またはプロジェクト名

planId

number

復元するテスト 計画の ID

戻り値

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

削除されたテスト スイートを復元します

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

パラメーター

payload
TestPlanAndSuiteRestoreModel

復元情報を含むモデル

project

string

プロジェクト ID またはプロジェクト名

suiteId

number

復元するテスト スイートの ID

戻り値

Promise<void>

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

テスト ケースの構成を更新する

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

パラメーター

suiteTestCaseCreateUpdateParameters

SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters オブジェクト。

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ケースを更新するテスト計画の ID。

suiteId

number

テスト ケースを更新するテスト スイートの ID。

戻り値

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

テスト構成を ID で更新します。

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

パラメーター

testConfigurationCreateUpdateParameters
TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project

string

プロジェクト ID またはプロジェクト名

testConfiguartionId

number

更新するテスト構成の ID。

戻り値

updateTestPlan(TestPlanUpdateParams, string, number)

テスト計画を更新します。

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

パラメーター

testPlanUpdateParams
TestPlanUpdateParams

testPlanUpdateParams オブジェクト。TestPlanUpdateParams

project

string

プロジェクト ID またはプロジェクト名

planId

number

更新するテスト計画の ID。

戻り値

Promise<TestPlan>

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

テスト ポイントを更新します。 これは、テスト ポイントをアクティブにリセットしたり、テスト ポイントの結果を更新したり、テスト ポイントのテスト担当者を更新したりするために使用されます。

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

パラメーター

testPointUpdateParams

TestPointUpdateParams[]

TestPointUpdateParams オブジェクト。

project

string

プロジェクト ID またはプロジェクト名

planId

number

テスト ポイントが要求されるテスト 計画の ID。

suiteId

number

テスト ポイントが要求されるテスト スイートの ID。

includePointDetails

boolean

false に設定すると、テスト ポイント オブジェクトに関する基本的な詳細のみを含む小さなペイロードが取得されます

returnIdentityRef

boolean

true に設定すると、TestCaseReference の AssignedTo フィールドが IdentityRef オブジェクトとして返されます。

戻り値

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

テスト スイートを更新します。

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

パラメーター

testSuiteUpdateParams
TestSuiteUpdateParams

スイート更新のパラメーター

project

string

プロジェクト ID またはプロジェクト名

planId

number

スイートを含むテスト 計画の ID。

suiteId

number

親スイートの ID。

戻り値

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

テスト変数を ID で更新します。

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

パラメーター

testVariableCreateUpdateParameters
TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project

string

プロジェクト ID またはプロジェクト名

testVariableId

number

更新するテスト変数の ID。

戻り値

Promise<TestVariable>