TestPlanRestClient class
应使用 (派生自) 的基类向 VSS REST API 发出请求
- Extends
构造函数
| Test |
方法
构造函数详细信息
TestPlanRestClient(IVssRestClientOptions)
方法详细信息
addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)
将测试用例添加到具有指定配置的套件
function addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>参数
- 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 或项目名称
返回
Promise<CloneTestCaseOperationInformation>
cloneTestPlan(CloneTestPlanParams, string, boolean)
克隆测试计划
function cloneTestPlan(cloneRequestBody: CloneTestPlanParams, project: string, deepClone?: boolean): Promise<CloneTestPlanOperationInformation>参数
- cloneRequestBody
- CloneTestPlanParams
计划克隆请求正文详细信息 TestPlanCloneRequest
- project
-
string
项目 ID 或项目名称
- deepClone
-
boolean
克隆所有关联的测试用例以及
返回
Promise<CloneTestPlanOperationInformation>
cloneTestSuite(CloneTestSuiteParams, string, boolean)
克隆测试套件
function cloneTestSuite(cloneRequestBody: CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<CloneTestSuiteOperationInformation>参数
- cloneRequestBody
- CloneTestSuiteParams
套件克隆请求正文详细信息 TestSuiteCloneRequest
- project
-
string
项目 ID 或项目名称
- deepClone
-
boolean
克隆所有关联的测试用例以及
返回
Promise<CloneTestSuiteOperationInformation>
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)
Create基于批量要求的测试套件。
function createBulkTestSuites(testSuiteCreateParams: TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestSuite[]>参数
- testSuiteCreateParams
用于创建套件的参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
需要在其中创建基于要求的套件的测试计划的 ID。
- parentSuiteId
-
number
将创建基于要求的套件的父套件的 ID
返回
Promise<TestSuite[]>
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)
Create测试配置。
function createTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string): Promise<TestConfiguration>参数
- testConfigurationCreateUpdateParameters
- TestConfigurationCreateUpdateParameters
TestConfigurationCreateUpdateParameters
- project
-
string
项目 ID 或项目名称
返回
Promise<TestConfiguration>
createTestPlan(TestPlanCreateParams, string)
Create测试计划。
function createTestPlan(testPlanCreateParams: TestPlanCreateParams, project: string): Promise<TestPlan>参数
- testPlanCreateParams
- TestPlanCreateParams
testPlanCreateParams 对象。TestPlanCreateParams
- project
-
string
项目 ID 或项目名称
返回
Promise<TestPlan>
createTestSuite(TestSuiteCreateParams, string, number)
Create测试套件。
function createTestSuite(testSuiteCreateParams: TestSuiteCreateParams, project: string, planId: number): Promise<TestSuite>参数
- testSuiteCreateParams
- TestSuiteCreateParams
用于创建套件的参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
包含套件的测试计划的 ID。
返回
Promise<TestSuite>
createTestVariable(TestVariableCreateUpdateParameters, string)
Create测试变量。
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
返回
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
项目 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，还将以递归方式提取属于子套件的测试点。
返回
getSuiteCloneInformation(string, number)
获取克隆信息。
function getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestSuiteOperationInformation>参数
- project
-
string
项目 ID 或项目名称
- cloneOperationId
-
number
将克隆操作排队时返回的操作 ID
返回
Promise<CloneTestSuiteOperationInformation>
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 等）作为 IdentityRef 对象返回。 如果设置为 false，则这些字段以字符串格式作为唯一名称返回。 默认情况下，这是 false。
返回
Promise<TestCase[]>
getTestCaseCloneInformation(string, number)
获取克隆信息。
function getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestCaseOperationInformation>参数
- project
-
string
项目 ID 或项目名称
- cloneOperationId
-
number
将克隆操作排队时返回的操作 ID
返回
Promise<CloneTestCaseOperationInformation>
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)
获取测试用例列表返回具有可选参数中提到的所有配置 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 等）作为 IdentityRef 对象返回。 如果设置为 false，则这些字段以字符串格式作为唯一名称返回。 默认为 false。
- expand
-
boolean
如果设置为 false， 将获取一个较小的有效负载，仅包含有关套件测试用例对象的基本详细信息
- excludeFlags
- ExcludeFlags
用于从有效负载中排除各种值的标志。 例如，删除点分配传递排除 = 1。 若要删除链接 (额外信息，测试计划 、测试套件) 通过排除 = 2。 若要删除额外信息和点分配，请传递排除 = 3 (1 + 2) 。
- isRecursive
-
boolean
返回
getTestConfigurationById(string, number)
获取测试配置
function getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestConfiguration>参数
- project
-
string
项目 ID 或项目名称
- testConfigurationId
-
number
要获取的测试配置的 ID。
返回
Promise<TestConfiguration>
getTestConfigurations(string, string)
获取测试配置的列表。
function getTestConfigurations(project: string, continuationToken?: string): Promise<PagedList<TestConfiguration>>参数
- project
-
string
项目 ID 或项目名称
- 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
项目 ID 或项目名称
- planId
-
number
- states
-
string
- outcome
- UserFriendlyTestOutcome
- configurations
-
string
- testers
-
string
- assignedTo
-
string
- entity
- TestEntityTypes
返回
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
仅获取活动计划
返回
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
如果返回的套件应位于树结构中。
返回
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”包含在响应标头中。 省略此参数可获取第一批测试变量。
返回
Promise<PagedList<TestVariable>>
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
要重新排序的 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 对象。
- 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。
返回
Promise<TestConfiguration>
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 对象。
- 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>