TestRestClient class

new TestRestClient(options: IVssRestClientOptions)

参数

static RESOURCE_AREA_ID: string

属性值

function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>

参数

返回

将测试用例添加到套件中。

function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

参数

返回

将测试结果添加到测试运行。

function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

参数

返回

function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>

参数

返回

附加文件以测试步骤结果

function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>

参数

返回

将文件附加到测试结果。

function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

参数

返回

创建新的测试运行。

function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>

参数

返回

将文件附加到测试运行。

function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

参数

返回

创建测试会话

function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

参数

返回

function createTestSettings(testSettings: TestSettings, project: string): Promise<number>

参数

返回

将文件附加到测试结果

function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

参数

返回

function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>

参数

返回

function deleteSharedStep(project: string, sharedStepId: number): Promise<void>

参数

返回

删除测试用例。

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

参数

返回

function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>

参数

返回

按其 ID 删除测试运行。

function deleteTestRun(project: string, runId: number): Promise<void>

参数

返回

function deleteTestSettings(project: string, testSettingsId: number): Promise<void>

参数

返回

function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

参数

返回

获取生成的代码覆盖率数据。

function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>

参数

返回

获取生成的代码覆盖率摘要。

function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>

参数

返回

function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>

参数

返回

获取测试点。

function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>

参数

返回

获取测试点列表。

function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>

参数

返回

使用查询获取测试点。

function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>

参数

返回

function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

参数

返回

function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

参数

返回

获取测试结果保留设置

function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>

参数

返回

在具有测试用例 ID 的测试套件中获取特定测试用例。

function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>

参数

返回

在套件中获取所有测试用例。

function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>

参数

返回

获取结果的迭代

function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>

参数

返回

获取结果的迭代

function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>

参数

返回

按其 ID 下载测试结果附件。

function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

参数

返回

获取测试结果附件参考列表。

function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>

参数

返回

按其 ID 下载测试结果附件。

function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

参数

返回

获取测试运行的测试结果。

function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>

参数

返回

function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

参数

返回

function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

参数

返回

获取测试运行的测试结果。

function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>

参数

返回

function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

参数

返回

此 API 将按 Id 返回结果，其中包含特定自动测试方法的指定字段/趋势。 我们仍在改进此 API，尚未最终确定正确的签名和合同。

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>

参数

返回

function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

参数

返回

按 ID 下载测试运行附件。

function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

参数

返回

获取测试运行附件参考列表。

function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>

参数

返回

按 ID 下载测试运行附件。

function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

参数

返回

按其 ID 获取测试运行。

function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>

参数

返回

获取测试运行的代码覆盖率数据

function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>

参数

返回

获取测试运行消息日志

function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>

参数

返回

获取测试运行列表。

function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>

参数

返回

获取测试运行统计信息 ，当我们想要获取运行结果的摘要时使用。

function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>

参数

返回

获取测试会话列表

function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>

参数

返回

function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>

参数

返回

下载测试子结果附件

function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

参数

返回

获取测试子结果附件列表

function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>

参数

返回

下载测试子结果附件

function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

参数

返回

处理测试套件的集合，并返回包含套件和测试用例详细信息的响应模型。

function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>

参数

返回

function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>

参数

返回

function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>

参数

返回

function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

参数

返回

function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

参数

返回

使用 TestHistoryQuery 获取测试方法的历史记录

function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>

参数

返回

function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>

参数

返回

function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>

参数

返回

获取相应 testcasereferenceId 的测试结果元数据详细信息列表

function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>

参数

返回

function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>

参数

返回

function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>

参数

返回

function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>

参数

返回

function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>

参数

返回

根据筛选器查询测试运行。 必填字段为 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>>

参数

返回

function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>

参数

返回

与测试用例关联的测试点将从测试套件中删除。 测试用例工作项不会从系统中删除。 请参阅测试用例资源以永久删除测试用例。

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

参数

返回

http://（tfsserver）：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10 请求：代码覆盖率摘要的 Json

function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>

参数

返回

更新测试结果保留设置

function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>

参数

返回

更新套件中测试用例关联的属性。

function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

参数

返回

更新测试点。

function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>

参数

返回

在测试运行中更新测试结果。

function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

参数

返回

按其 ID 更新测试运行。

function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>

参数

返回

更新测试会话

function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

参数

返回