TestRestClient class
应使用的基类 (派生自) 以向 VSS REST API 发出请求
- Extends
构造函数
| Test |
属性
| RESOURCE_AREA_ID |
方法
构造函数详细信息
TestRestClient(IVssRestClientOptions)
属性详细信息
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string属性值
string
方法详细信息
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>参数
- newFields
- project
-
string
项目 ID 或项目名称
返回
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
将测试用例添加到套件。
function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
包含套件的测试计划的 ID。
- suiteId
-
number
必须向其添加测试用例的测试套件的 ID。
- testCaseIds
-
string
要添加到套件的测试用例的 ID。 ID 以逗号分隔的格式指定。
返回
Promise<SuiteTestCase[]>
addTestResultsToTestRun(TestCaseResult[], string, number)
将测试结果添加到测试运行。
function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>参数
- results
要添加的测试结果列表。
- project
-
string
项目 ID 或项目名称
- runId
-
number
测试运行 ID，其中要添加测试结果。
返回
Promise<TestCaseResult[]>
addWorkItemToTestLinks(WorkItemToTestLinks, string)
function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>参数
- workItemToTestLinks
- WorkItemToTestLinks
- project
-
string
项目 ID 或项目名称
返回
Promise<WorkItemToTestLinks>
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
将文件附加到测试步骤结果
function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>参数
- attachmentRequestModel
- TestAttachmentRequestModel
附件详细信息 TestAttachmentRequestModel
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含迭代的测试结果的 ID
- iterationId
-
number
测试结果迭代的 ID。
- actionPath
-
string
测试结果操作路径的十六进制值。
返回
Promise<TestAttachmentReference>
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
将文件附加到测试结果。
function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>参数
- attachmentRequestModel
- TestAttachmentRequestModel
附件详细信息 TestAttachmentRequestModel
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
必须对其上传附件的测试结果的 ID。
返回
Promise<TestAttachmentReference>
createTestRun(RunCreateModel, string)
创建新的测试运行。
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>参数
- testRun
- RunCreateModel
运行详细信息 RunCreateModel
- project
-
string
项目 ID 或项目名称
返回
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
将文件附加到测试运行。
function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>参数
- attachmentRequestModel
- TestAttachmentRequestModel
附件详细信息 TestAttachmentRequestModel
- project
-
string
项目 ID 或项目名称
- runId
-
number
必须对其上传附件的测试运行的 ID。
返回
Promise<TestAttachmentReference>
createTestSession(TestSession, TeamContext)
创建测试会话
function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>参数
- testSession
- TestSession
用于创建的测试会话详细信息
- teamContext
- TeamContext
操作的团队上下文
返回
Promise<TestSession>
createTestSettings(TestSettings, string)
function createTestSettings(testSettings: TestSettings, project: string): Promise<number>参数
- testSettings
- TestSettings
- project
-
string
项目 ID 或项目名称
返回
Promise<number>
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
将文件附加到测试结果
function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>参数
- attachmentRequestModel
- TestAttachmentRequestModel
附件请求模型。
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含子结果的测试结果的 ID。
- testSubResultId
-
number
必须对其上传附件的测试子结果的 ID。
返回
Promise<TestAttachmentReference>
deleteSharedParameter(string, number)
function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- sharedParameterId
-
number
返回
Promise<void>
deleteSharedStep(string, number)
function deleteSharedStep(project: string, sharedStepId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- sharedStepId
-
number
返回
Promise<void>
deleteTestCase(string, number)
删除测试用例。
function deleteTestCase(project: string, testCaseId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- testCaseId
-
number
要删除的测试用例的 ID。
返回
Promise<void>
deleteTestMethodToWorkItemLink(string, string, number)
function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>参数
- project
-
string
项目 ID 或项目名称
- testName
-
string
- workItemId
-
number
返回
Promise<boolean>
deleteTestRun(string, number)
按 ID 删除测试运行。
function deleteTestRun(project: string, runId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
要删除的运行的 ID。
返回
Promise<void>
deleteTestSettings(string, number)
function deleteTestSettings(project: string, testSettingsId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- testSettingsId
-
number
返回
Promise<void>
getBugsLinkedToTestResult(string, number, number)
function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
- testCaseResultId
-
number
返回
Promise<WorkItemReference[]>
getBuildCodeCoverage(string, number, number)
获取生成的代码覆盖率数据。
function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
需要为其提取代码覆盖率数据的生成的 ID。
- flags
-
number
标志的值确定要提取的代码覆盖率详细信息的级别。 标志是累加的。 模块的预期值为 1，函数为 2，BlockData 为 4。
返回
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
获取生成的代码覆盖率摘要。
function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
需要为其提取代码覆盖率数据的生成的 ID。
- deltaBuildId
-
number
增量生成 ID (可选)
返回
Promise<CodeCoverageSummary>
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>参数
- workItemQuery
- LinkedWorkItemsQuery
- project
-
string
项目 ID 或项目名称
返回
Promise<LinkedWorkItemsQueryResult[]>
getPoint(string, number, number, number, string)
获取测试点。
function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
测试计划的 ID。
- suiteId
-
number
包含点的套件的 ID。
- pointIds
-
number
要获取的测试点的 ID。
- witFields
-
string
工作项字段名称的逗号分隔列表。
返回
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
获取测试点的列表。
function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
测试计划的 ID。
- suiteId
-
number
包含点的套件的 ID。
- witFields
-
string
工作项字段名称的逗号分隔列表。
- configurationId
-
string
获取特定配置的测试点。
- testCaseId
-
string
获取特定测试用例的测试点，在未设置 configurationId 时有效。
- testPointIds
-
string
获取以逗号分隔的测试点 ID 列表的测试点，仅在未设置 configurationId 和 testCaseId 时有效。
- includePointDetails
-
boolean
包括测试点的所有属性。
- skip
-
number
要跳过的测试点数。
- top
-
number
要返回的测试点数。
返回
Promise<TestPoint[]>
getPointsByQuery(TestPointsQuery, string, number, number)
使用查询获取测试点。
function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>参数
- query
- TestPointsQuery
用于获取测试点的 TestPointsQuery。
- project
-
string
项目 ID 或项目名称
- skip
-
number
要跳过的测试点数。
- top
-
number
要返回的测试点数。
返回
Promise<TestPointsQuery>
getResultGroupsByBuild(string, number, string, string[], string)
function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- publishContext
-
string
- fields
-
string[]
- continuationToken
-
string
返回
Promise<PagedList<FieldDetailsForTestResults>>
getResultGroupsByRelease(string, number, string, number, string[], string)
function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>参数
- project
-
string
项目 ID 或项目名称
- releaseId
-
number
- publishContext
-
string
- releaseEnvId
-
number
- fields
-
string[]
- continuationToken
-
string
返回
Promise<PagedList<FieldDetailsForTestResults>>
getResultRetentionSettings(string)
获取测试结果保留设置
function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<ResultRetentionSettings>
getTestCaseById(string, number, number, number)
获取具有测试用例 ID 的测试套件中的特定测试用例。
function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
包含套件的测试计划的 ID。
- suiteId
-
number
包含测试用例的套件的 ID。
- testCaseIds
-
number
要获取的测试用例的 ID。
返回
Promise<SuiteTestCase>
getTestCases(string, number, number)
获取套件中的所有测试用例。
function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
包含套件的测试计划的 ID。
- suiteId
-
number
要获取的套件的 ID。
返回
Promise<SuiteTestCase[]>
getTestIteration(string, number, number, number, boolean)
获取结果的迭代
function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含迭代的测试结果的 ID。
- iterationId
-
number
测试结果迭代的 ID。
- includeActionResults
-
boolean
包括测试迭代中执行的每个操作的结果详细信息。 ActionResults 是指作为运行手动测试的一部分执行的测试步骤的结果 (通过/失败) 。 包括 ActionResults 标志可获取 actionResults 部分中的测试步骤的结果，以及每个测试迭代的参数部分中的测试参数。
返回
Promise<TestIterationDetailsModel>
getTestIterations(string, number, number, boolean)
获取结果的迭代
function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含迭代的测试结果的 ID。
- includeActionResults
-
boolean
包括测试迭代中执行的每个操作的结果详细信息。 ActionResults 是指作为运行手动测试的一部分执行的测试步骤的结果 (通过/失败) 。 包括 ActionResults 标志可获取 actionResults 部分中的测试步骤的结果，以及每个测试迭代的参数部分中的测试参数。
返回
Promise<TestIterationDetailsModel[]>
getTestResultAttachmentContent(string, number, number, number)
按 ID 下载测试结果附件。
function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含 testCaseResultId 的测试运行的 ID。
- testCaseResultId
-
number
必须下载其附件的测试结果的 ID。
- attachmentId
-
number
要下载的测试结果附件的 ID。
返回
Promise<ArrayBuffer>
getTestResultAttachments(string, number, number)
获取测试结果附件引用的列表。
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
测试结果的 ID。
返回
Promise<TestAttachment[]>
getTestResultAttachmentZip(string, number, number, number)
按 ID 下载测试结果附件。
function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含 testCaseResultId 的测试运行的 ID。
- testCaseResultId
-
number
必须下载其附件的测试结果的 ID。
- attachmentId
-
number
要下载的测试结果附件的 ID。
返回
Promise<ArrayBuffer>
getTestResultById(string, number, number, ResultDetails)
获取测试运行的测试结果。
function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
要提取的测试结果的测试运行 ID。
- testCaseResultId
-
number
测试结果 ID。
- detailsToInclude
- ResultDetails
要包含在测试结果中的详细信息。 默认值为 None。 其他值包括 Iterations、WorkItems 和 SubResults。
返回
Promise<TestCaseResult>
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
返回
Promise<TestResultsDetails>
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>参数
- project
-
string
项目 ID 或项目名称
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
返回
Promise<TestResultsDetails>
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])
获取测试运行的测试结果。
function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
要提取的测试结果的测试运行 ID。
- detailsToInclude
- ResultDetails
要包含在测试结果中的详细信息。 默认值为 None。 其他值为 Iterations 和 WorkItems。
- skip
-
number
要从头开始跳过的测试结果数。
- top
-
number
要返回的测试结果数。 detailsToInclude 为 None 时，最大值为 1000，否则为 200。
- outcomes
用于筛选测试结果的测试结果的逗号分隔列表。
返回
Promise<TestCaseResult[]>
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
返回
Promise<PagedList<ShallowTestCaseResult>>
getTestResultsByQuery(TestResultsQuery, string)
此 API 将按 ID 返回结果，其中指定了特定自动测试方法的字段/趋势。 我们仍在改进此 API，但尚未最终确定适当的签名和合同。
function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>参数
- query
- TestResultsQuery
- project
-
string
项目 ID 或项目名称
返回
Promise<TestResultsQuery>
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>参数
- project
-
string
项目 ID 或项目名称
- releaseId
-
number
- releaseEnvid
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
返回
Promise<PagedList<ShallowTestCaseResult>>
getTestRunAttachmentContent(string, number, number)
按 ID 下载测试运行附件。
function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
必须下载其附件的测试运行的 ID。
- attachmentId
-
number
要下载的测试运行附件的 ID。
返回
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
获取测试运行附件引用的列表。
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
测试运行的 ID。
返回
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
按 ID 下载测试运行附件。
function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
必须下载其附件的测试运行的 ID。
- attachmentId
-
number
要下载的测试运行附件的 ID。
返回
Promise<ArrayBuffer>
getTestRunById(string, number, boolean)
按 ID 获取测试运行。
function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
要获取的运行 ID。
- includeDetails
-
boolean
默认值为 true。 它包括运行统计信息、发布、生成、测试环境、后处理状态等详细信息。
返回
Promise<TestRun>
getTestRunCodeCoverage(string, number, number)
获取测试运行的代码覆盖率数据
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
需要为其提取代码覆盖率数据的测试运行的 ID。
- flags
-
number
标志的值确定要提取的代码覆盖率详细信息的级别。 标志是累加的。 模块的预期值为 1，函数为 2，BlockData 为 4。
返回
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
获取测试运行消息日志
function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
要获取的运行 ID。
返回
Promise<TestMessageLogDetails[]>
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
获取测试运行的列表。
function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>参数
- project
-
string
项目 ID 或项目名称
- buildUri
-
string
运行的使用的生成的 URI。
- owner
-
string
运行所有者的团队基础 ID。
- tmiRunId
-
string
- planId
-
number
运行所属的测试计划的 ID。
- includeRunDetails
-
boolean
如果为 true，则包括运行的所有属性。
- automated
-
boolean
如果为 true，则仅返回自动运行。
- skip
-
number
要跳过的测试运行数。
- top
-
number
要返回的测试运行数。
返回
Promise<TestRun[]>
getTestRunStatistics(string, number)
获取测试运行统计信息 ，在我们想要按结果获取运行摘要时使用。
function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
要获取的运行 ID。
返回
Promise<TestRunStatistic>
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)
获取测试会话的列表
function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>参数
- teamContext
- TeamContext
操作的团队上下文
- period
-
number
从现在起的时间段（以天为单位），将为其提取测试会话。
- allSessions
-
boolean
如果为 false，则返回当前用户的测试会话。 否则，它将返回所有用户的测试会话
- includeAllProperties
-
boolean
如果为 true，则返回测试会话的所有属性。 否则，它将返回瘦版本。
- source
- TestSessionSource
测试会话的源。
- includeOnlyCompletedSessions
-
boolean
如果为 true，则返回处于已完成状态的测试会话。 否则，它将返回所有状态的测试会话
返回
Promise<TestSession[]>
getTestSettingsById(string, number)
function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>参数
- project
-
string
项目 ID 或项目名称
- testSettingsId
-
number
返回
Promise<TestSettings>
getTestSubResultAttachmentContent(string, number, number, number, number)
下载测试子结果附件
function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含子结果的测试结果的 ID。
- attachmentId
-
number
要下载的测试结果附件的 ID
- testSubResultId
-
number
必须下载其附件的测试子结果的 ID
返回
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
获取测试子结果附件列表
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含子结果的测试结果的 ID。
- testSubResultId
-
number
必须下载其附件的测试子结果的 ID
返回
Promise<TestAttachment[]>
getTestSubResultAttachmentZip(string, number, number, number, number)
下载测试子结果附件
function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- runId
-
number
包含结果的测试运行的 ID。
- testCaseResultId
-
number
包含子结果的测试结果的 ID。
- attachmentId
-
number
要下载的测试结果附件的 ID
- testSubResultId
-
number
必须下载其附件的测试子结果的 ID
返回
Promise<ArrayBuffer>
publishTestResultDocument(TestResultDocument, string, number)
function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>参数
- document
- TestResultDocument
- project
-
string
项目 ID 或项目名称
- runId
-
number
返回
Promise<TestResultDocument>
queryCustomFields(string, CustomTestFieldScope)
function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>参数
- project
-
string
项目 ID 或项目名称
- scopeFilter
- CustomTestFieldScope
返回
Promise<CustomTestFieldDefinition[]>
queryResultTrendForBuild(TestResultTrendFilter, string)
function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>参数
- filter
- TestResultTrendFilter
- project
-
string
项目 ID 或项目名称
返回
Promise<AggregatedDataForResultTrend[]>
queryResultTrendForRelease(TestResultTrendFilter, string)
function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>参数
- filter
- TestResultTrendFilter
- project
-
string
项目 ID 或项目名称
返回
Promise<AggregatedDataForResultTrend[]>
queryTestHistory(TestHistoryQuery, string)
使用 TestHistoryQuery 获取测试方法的历史记录
function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>参数
- filter
- TestHistoryQuery
用于获取历史记录的 TestHistoryQuery
- project
-
string
项目 ID 或项目名称
返回
Promise<TestHistoryQuery>
queryTestMethodLinkedWorkItems(string, string)
function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>参数
- project
-
string
项目 ID 或项目名称
- testName
-
string
返回
Promise<TestToWorkItemLinks>
queryTestResultHistory(ResultsFilter, string)
function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>参数
- filter
- ResultsFilter
- project
-
string
项目 ID 或项目名称
返回
Promise<TestResultHistory>
queryTestResultsMetaData(string[], string)
获取相应 testcasereferenceId 的测试结果元数据详细信息列表
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>参数
- testReferenceIds
-
string[]
TestCaseReference 要查询的测试结果的 ID，以逗号分隔的有效 ID 列表 (id 的限制编号 200) 。
- project
-
string
项目 ID 或项目名称
返回
Promise<TestResultMetaData[]>
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- buildToCompare
- BuildReference
返回
Promise<TestResultSummary>
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>参数
- project
-
string
项目 ID 或项目名称
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- releaseToCompare
- ReleaseReference
返回
Promise<TestResultSummary>
queryTestResultsSummaryForReleases(ReleaseReference[], string)
function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>参数
- releases
- project
-
string
项目 ID 或项目名称
返回
Promise<TestResultSummary[]>
queryTestResultWorkItems(string, string, string, number, Date, number, number)
function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>参数
- project
-
string
项目 ID 或项目名称
- workItemCategory
-
string
- automatedTestName
-
string
- testCaseId
-
number
- maxCompleteDate
-
Date
- days
-
number
- workItemCount
-
number
返回
Promise<WorkItemReference[]>
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)
查询测试基于筛选器运行。 必填字段为 minLastUpdatedDate 和 maxLastUpdatedDate。
function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, continuationToken?: string): Promise<PagedList<TestRun>>参数
- project
-
string
项目 ID 或项目名称
- minLastUpdatedDate
-
Date
要查询的最小上次修改日期 (必需) 。
- maxLastUpdatedDate
-
Date
要查询的最大上次修改运行日期 (必需，最小和最大日期之间的差值最长为 7 天) 。
- state
- TestRunState
要查询的运行的当前状态。
- planIds
-
number[]
要查询的运行的计划 ID，有效 ID 的逗号分隔列表 (id 限制为 10) 。
- isAutomated
-
boolean
要查询的运行的自动化类型。
- publishContext
- TestRunPublishContext
要查询的运行的 PublishContext。
- buildIds
-
number[]
要查询的运行的生成 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
- buildDefIds
-
number[]
生成要查询的运行的定义 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
- branchName
-
string
要查询的运行的源分支名称。
- releaseIds
-
number[]
要查询的运行的版本 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
- releaseDefIds
-
number[]
要查询的运行的发布定义 ID，以逗号分隔的有效 ID 列表 (id 限制编号 10) 。
- releaseEnvIds
-
number[]
要查询的运行的发布环境 ID，以逗号分隔的有效 ID 列表 (id 限制编号 10) 。
- releaseEnvDefIds
-
number[]
发布要查询的运行的环境定义 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
- runTitle
-
string
运行要查询的运行标题。
- top
-
number
要查询的运行数。 限制为 100
- continuationToken
-
string
continuationToken 从上一批接收，对于第一批为 null。 如果用户从上一批) 接收，则不应 (或更改它。
返回
queryTestSummaryByRequirement(TestResultsContext, string, number[])
function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>参数
- resultsContext
- TestResultsContext
- project
-
string
项目 ID 或项目名称
- workItemIds
-
number[]
返回
Promise<TestSummaryForWorkItem[]>
removeTestCasesFromSuiteUrl(string, number, number, string)
与测试用例关联的测试点将从测试套件中删除。 不会从系统中删除测试用例工作项。 请参阅测试用例资源以永久删除测试用例。
function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- planId
-
number
包含套件的测试计划的 ID。
- suiteId
-
number
要获取的套件的 ID。
- testCaseIds
-
string
要从套件中删除的测试用例的 ID。
返回
Promise<void>
updateCodeCoverageSummary(CodeCoverageData, string, number)
http：// (tfsserver) ：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10 请求：代码覆盖率摘要的 Json
function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>参数
- coverageData
- CodeCoverageData
- project
-
string
项目 ID 或项目名称
- buildId
-
number
返回
Promise<void>
updateResultRetentionSettings(ResultRetentionSettings, string)
更新测试结果保留设置
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>参数
- retentionSettings
- ResultRetentionSettings
要更新的测试结果保留设置详细信息
- project
-
string
项目 ID 或项目名称
返回
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
汇报套件中测试用例关联的属性。
function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>参数
- suiteTestCaseUpdateModel
- SuiteTestCaseUpdateModel
用于更新测试用例套件关联的属性的模型。
- project
-
string
项目 ID 或项目名称
- planId
-
number
包含套件的测试计划的 ID。
- suiteId
-
number
测试用例必须添加到的测试套件的 ID。
- testCaseIds
-
string
要添加到套件的测试用例的 ID。 ID 以逗号分隔格式指定。
返回
Promise<SuiteTestCase[]>
updateTestPoints(PointUpdateModel, string, number, number, string)
更新测试点。
function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>参数
- pointUpdateModel
- PointUpdateModel
要更新的数据。
- project
-
string
项目 ID 或项目名称
- planId
-
number
测试计划的 ID。
- suiteId
-
number
包含点的套件的 ID。
- pointIds
-
string
要获取的测试点的 ID。 使用逗号分隔的 ID 列表更新多个测试点。
返回
Promise<TestPoint[]>
updateTestResults(TestCaseResult[], string, number)
更新测试运行中的测试结果。
function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>参数
- results
要更新的测试结果列表。
- project
-
string
项目 ID 或项目名称
- runId
-
number
要更新其测试结果的测试运行 ID。
返回
Promise<TestCaseResult[]>
updateTestRun(RunUpdateModel, string, number)
按其 ID 运行的更新测试。
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>参数
- runUpdateModel
- RunUpdateModel
运行详细信息 RunUpdateModel
- project
-
string
项目 ID 或项目名称
- runId
-
number
要更新的运行 ID。
返回
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
更新测试会话
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>参数
- testSession
- TestSession
更新的测试会话详细信息
- teamContext
- TeamContext
操作的团队上下文
返回
Promise<TestSession>
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈