TestPlanRestClient class

參考

套件:: azure-devops-extension-api

應該用來對 VSS REST API 提出要求的基類（衍生自）

Extends: RestClientBase

建構函式

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)	建立測試計劃。
createTestSuite(TestSuiteCreateParams, string, number)	建立測試套件。
createTestVariable(TestVariableCreateUpdateParameters, string)	建立測試變數。
deleteTestCase(string, number)	刪除測試案例。
deleteTestConfguration(string, number)	依標識碼刪除測試組態。
deleteTestPlan(string, number)	刪除測試計劃。
deleteTestSuite(string, number, number)	刪除測試套件。
deleteTestVariable(string, number)	依其標識碼刪除測試變數。
exportTestCases(ExportTestCaseParams, string)	將一組測試案例從套件匯出至檔案。目前支援的格式：xlsx
getCloneInformation(string, number)	取得複製資訊。
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)	取得測試案例清單會傳回具有選擇性參數中所述所有組態標識碼的測試案例。如果組態標識碼為 Null，則會傳回所有測試案例
getTestConfigurationById(string, number)	取得測試組態
getTestConfigurations(string, string)	取得測試組態的清單。
getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)
getTestPlanById(string, number)	依標識碼取得測試計劃。
getTestPlans(string, string, string, boolean, boolean)	取得測試計劃清單
getTestSuiteById(string, number, number, SuiteExpand)	依套件識別碼取得測試套件。
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	取得方案的測試套件。
getTestVariableById(string, number)	依其標識碼取得測試變數。
getTestVariables(string, string)	取得測試變數的清單。
removeTestCasesFromSuite(string, number, number, string)	根據所提供的測試案例標識碼清單，從套件中移除測試案例案例。
removeTestCasesListFromSuite(string, number, number, string)	根據所提供的測試案例標識碼清單，從套件中移除測試案例案例。此 API 可用來移除大量的測試案例。
reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)	在測試套件中重新排列測試套件專案。
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	還原已刪除的測試計劃
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	還原已刪除的測試套件
updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)	更新測試案例的組態
updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)	依標識碼更新測試組態。
updateTestPlan(TestPlanUpdateParams, string, number)	更新測試計劃。
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	更新測試點。這是用來將測試點重設為作用中、更新測試點的結果，或更新測試點的測試者
updateTestSuite(TestSuiteUpdateParams, string, number, number)	更新測試套件。
updateTestVariable(TestVariableCreateUpdateParameters, string, number)	依其標識碼更新測試變數。

建構函式詳細資料

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

參數

options: IVssRestClientOptions

方法詳細資料

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

將測試案例新增至具有指定組態的套件

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

參數

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters 物件。

project: string

項目識別碼或項目名稱

planId: number

要加入測試案例的測試計劃標識碼。

suiteId: number

要加入測試案例的測試套件識別碼。

傳回

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

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

參數

cloneRequestBody: CloneTestCaseParams

project: string

項目識別碼或項目名稱

傳回

Promise<CloneTestCaseOperationInformation>

cloneTestPlan(CloneTestPlanParams, string, boolean)

複製測試計劃

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

參數

cloneRequestBody: CloneTestPlanParams

計劃複製要求本文詳細數據 TestPlanCloneRequest

project: string

項目識別碼或項目名稱

deepClone: boolean

複製所有相關聯的測試案例

傳回

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

複製測試套件

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

參數

cloneRequestBody: CloneTestSuiteParams

Suite Clone 要求本文詳細數據 TestSuiteCloneRequest

project: string

項目識別碼或項目名稱

deepClone: boolean

複製所有相關聯的測試案例

傳回

Promise<CloneTestSuiteOperationInformation>

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

建立大量需求型測試套件。

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

參數

testSuiteCreateParams: TestSuiteCreateParams[]

套件建立的參數

project: string

項目識別碼或項目名稱

planId: number

需要建立需求型套件的測試計劃標識碼。

parentSuiteId: number

要在其中建立需求型套件之父套件的標識碼

傳回

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

建立測試組態。

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

參數

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

項目識別碼或項目名稱

傳回

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

建立測試計劃。

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

參數

testPlanCreateParams: TestPlanCreateParams

testPlanCreateParams 物件。TestPlanCreateParams

project: string

項目識別碼或項目名稱

傳回

Promise<TestPlan>

createTestSuite(TestSuiteCreateParams, string, number)

建立測試套件。

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

參數

testSuiteCreateParams: TestSuiteCreateParams

套件建立的參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

傳回

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

建立測試變數。

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

參數

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

項目識別碼或項目名稱

傳回

Promise<TestVariable>

deleteTestCase(string, number)

刪除測試案例。

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

參數

project: string

項目識別碼或項目名稱

testCaseId: number

要刪除的測試案例標識碼。

傳回

Promise<void>

deleteTestConfguration(string, number)

依標識碼刪除測試組態。

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

參數

project: string

項目識別碼或項目名稱

testConfiguartionId: number

要刪除的測試組態標識碼。

傳回

Promise<void>

deleteTestPlan(string, number)

刪除測試計劃。

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

參數

project: string

項目識別碼或項目名稱

planId: number

要刪除的測試計劃標識碼。

傳回

Promise<void>

deleteTestSuite(string, number, number)

刪除測試套件。

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

參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

要刪除的測試套件識別碼。

傳回

Promise<void>

deleteTestVariable(string, number)

依其標識碼刪除測試變數。

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

參數

project: string

項目識別碼或項目名稱

testVariableId: number

要刪除的測試變數標識碼。

傳回

Promise<void>

exportTestCases(ExportTestCaseParams, string)

將一組測試案例從套件匯出至檔案。目前支援的格式：xlsx

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

參數

exportTestCaseRequestBody: ExportTestCaseParams

ExportTestCaseParams 物件。ExportTestCaseParams

project: string

項目識別碼或項目名稱

傳回

Promise<ArrayBuffer>

getCloneInformation(string, number)

取得複製資訊。

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

參數

project: string

項目識別碼或項目名稱

cloneOperationId: number

當我們將複製作業排入佇列時傳回的作業標識碼

傳回

Promise<CloneTestPlanOperationInformation>

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

項目識別碼或項目名稱

planId: number

要求測試點的測試計劃標識碼。

suiteId: number

要求測試點的測試套件識別碼。

pointId: string

要擷取的測試點標識碼。

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

項目識別碼或項目名稱

planId: number

要求測試點的測試計劃標識碼。

suiteId: number

要求測試點的測試套件識別碼

testPointIds: string

要擷取的測試點標識碼。

testCaseId: string

取得特定測試案例標識碼的測試點。

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

項目識別碼或項目名稱

cloneOperationId: number

當我們將複製作業排入佇列時傳回的作業標識碼

傳回

Promise<CloneTestSuiteOperationInformation>

getSuiteEntries(string, number, SuiteEntryTypes)

取得測試套件中的測試套件項目清單。

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

參數

project: string

項目識別碼或項目名稱

suiteId: number

父套件的標識碼。

suiteEntryType: SuiteEntryTypes

傳回

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

尋找給定測試案例存在的所有測試套件清單。如果您需要瞭解哪些測試套件使用測試案例，當您需要變更測試案例時，這會很有説明。

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

參數

testCaseId: number

需要擷取套件的測試案例標識碼。

傳回

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

項目識別碼或項目名稱

planId: number

要求測試案例的測試計劃標識碼。

suiteId: number

要求測試案例的測試套件識別碼。

testCaseId: string

要擷取的測試案例標識碼。

witFields: string

取得 witFields 的清單。

returnIdentityRef: boolean

如果設定為 true，則會傳回所有識別字段，例如 AssignedTo、ActivatedBy 等，做為 IdentityRef 物件。如果設定為 false，這些字段會以字串格式傳回為唯一名稱。根據預設，這是 false。

傳回

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

取得複製資訊。

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

參數

project: string

項目識別碼或項目名稱

cloneOperationId: number

當我們將複製作業排入佇列時傳回的作業標識碼

傳回

Promise<CloneTestCaseOperationInformation>

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

取得測試案例清單會傳回具有選擇性參數中所述所有組態標識碼的測試案例。如果組態標識碼為 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

項目識別碼或項目名稱

planId: number

要求測試案例的測試計劃標識碼。

suiteId: number

要求測試案例的測試套件識別碼。

testIds: string

要擷取的測試案例標識碼。

configurationIds: string

擷取包含指定之所有組態標識碼的測試案例。

witFields: string

取得 witFields 的清單。

continuationToken: string

如果傳回的測試案例清單尚未完成，則響應標頭中會包含一個接續令牌來查詢下一批測試案例，作為 “x-ms-continuationtoken”。省略此參數以取得第一批測試案例。

returnIdentityRef: boolean

expand: boolean

如果設定為 false，將取得較小的承載，只包含套件測試案例物件的基本詳細數據

excludeFlags: ExcludeFlags

將各種值從承載中排除的旗標。例如，移除點指派傳遞exclude = 1。若要移除額外的信息（鏈接、測試計劃、測試套件）通過 exclude = 2。若要移除額外的信息和點指派，傳遞 exclude = 3 （1 + 2）。

isRecursive: boolean

傳回

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

取得測試組態

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

參數

project: string

項目識別碼或項目名稱

testConfigurationId: number

要取得的測試組態標識碼。

傳回

Promise<TestConfiguration>

getTestConfigurations(string, string)

取得測試組態的清單。

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

參數

project: string

項目識別碼或項目名稱

continuationToken: string

如果傳回的組態清單尚未完成，則響應標頭中會包含查詢下一批組態的接續令牌，做為 “x-ms-continuationtoken”。省略此參數以取得第一批測試組態。

傳回

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

參數

project: string

項目識別碼或項目名稱

planId: number

states: string

outcome: UserFriendlyTestOutcome

configurations: string

testers: string

assignedTo: string

entity: TestEntityTypes

傳回

Promise<TestEntityCount[]>

getTestPlanById(string, number)

依標識碼取得測試計劃。

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

參數

project: string

項目識別碼或項目名稱

planId: number

要取得的測試計劃標識碼。

傳回

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

項目識別碼或項目名稱

owner: string

依擁有者識別碼或名稱篩選測試計劃

continuationToken: string

如果傳回的計劃清單尚未完成，則響應標頭中會包含一個接續令牌來查詢下一批計劃，做為 “x-ms-continuationtoken”。省略此參數以取得第一批測試計劃。

includePlanDetails: boolean

取得測試計劃的所有屬性

filterActivePlans: boolean

只取得作用中的計劃

傳回

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

依套件識別碼取得測試套件。

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

參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

要取得的套件標識碼。

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

項目識別碼或項目名稱

planId: number

要求套件的測試計劃標識碼。

expand: SuiteExpand

包含子套件和測試人員詳細數據。

continuationToken: string

如果傳回的套件清單尚未完成，則會在響應標頭中包含要查詢下一批套件的接續令牌，做為 “x-ms-continuationtoken”。省略此參數以取得第一批測試套件。

asTreeView: boolean

如果傳回的套件應該位於樹狀結構中。

傳回

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

依其標識碼取得測試變數。

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

參數

project: string

項目識別碼或項目名稱

testVariableId: number

要取得的測試變數標識碼。

傳回

Promise<TestVariable>

getTestVariables(string, string)

取得測試變數的清單。

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

參數

project: string

項目識別碼或項目名稱

continuationToken: string

如果傳回的變數清單不完整，則響應標頭中會包含查詢下一批變數的接續令牌，做為 “x-ms-continuationtoken”。省略此參數以取得第一批測試變數。

傳回

Promise<PagedList<TestVariable>>

removeTestCasesFromSuite(string, number, number, string)

根據所提供的測試案例標識碼清單，從套件中移除測試案例案例。

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

參數

project: string

項目識別碼或項目名稱

planId: number

要從中移除測試案例的測試計劃標識碼。

suiteId: number

要從中移除測試案例的測試套件標識碼。

testCaseIds: string

要移除的測試案例標識碼。

傳回

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

根據所提供的測試案例標識碼清單，從套件中移除測試案例案例。此 API 可用來移除大量的測試案例。

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

參數

project: string

項目識別碼或項目名稱

planId: number

要從中移除測試案例的測試計劃標識碼。

suiteId: number

要從中移除測試案例的測試套件標識碼。

testIds: string

要移除之測試案例標識碼的逗號分隔字串。

傳回

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

在測試套件中重新排列測試套件專案。

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

參數

suiteEntries: SuiteEntryUpdateParams[]

要重新排序的 SuiteEntry 清單。

project: string

項目識別碼或項目名稱

suiteId: number

父測試套件的標識碼。

傳回

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

還原已刪除的測試計劃

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

參數

restoreModel: TestPlanAndSuiteRestoreModel

包含還原資訊的模型

project: string

項目識別碼或項目名稱

planId: number

要還原的測試計劃標識碼

傳回

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

還原已刪除的測試套件

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

參數

payload: TestPlanAndSuiteRestoreModel

包含還原資訊的模型

project: string

項目識別碼或項目名稱

suiteId: number

要還原的測試套件識別碼

傳回

Promise<void>

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

更新測試案例的組態

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

參數

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters 物件。

project: string

項目識別碼或項目名稱

planId: number

要更新測試案例的測試計劃標識碼。

suiteId: number

要更新測試案例的測試套件識別碼。

傳回

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

依標識碼更新測試組態。

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

參數

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

項目識別碼或項目名稱

testConfiguartionId: number

要更新的測試組態標識碼。

傳回

Promise<TestConfiguration>

updateTestPlan(TestPlanUpdateParams, string, number)

更新測試計劃。

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

參數

testPlanUpdateParams: TestPlanUpdateParams

testPlanUpdateParams 物件。TestPlanUpdateParams

project: string

項目識別碼或項目名稱

planId: number

要更新的測試計劃標識碼。

傳回

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

項目識別碼或項目名稱

planId: number

要求測試點的測試計劃標識碼。

suiteId: number

要求測試點的測試套件識別碼。

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

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

父套件的標識碼。

傳回

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

依其標識碼更新測試變數。

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

參數

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

項目識別碼或項目名稱

testVariableId: number

要更新的測試變數標識碼。

傳回

Promise<TestVariable>

共用方式為

TestPlanRestClient class

建構函式

方法

建構函式詳細資料

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)

參數

傳回

createTestSuite(TestSuiteCreateParams, string, number)

參數

傳回

createTestVariable(TestVariableCreateUpdateParameters, string)

參數

傳回

deleteTestCase(string, number)

參數

傳回

deleteTestConfguration(string, number)

參數

傳回

deleteTestPlan(string, number)

參數

傳回

deleteTestSuite(string, number, number)

參數

傳回

deleteTestVariable(string, number)

參數

傳回

exportTestCases(ExportTestCaseParams, string)

參數

傳回

getCloneInformation(string, number)

參數

傳回

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)

參數

傳回