TestResultsRestClient class

new TestResultsRestClient(options: IVssRestClientOptions)

參數

static RESOURCE_AREA_ID: string

屬性值

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

參數

傳回

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

參數

傳回

將測試結果新增至測試回合會話

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

參數

傳回

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

參數

傳回

在指定會話的 TCM 資料存放區中建立工作階段分析物件

function createAnalysis(analysis: TestSessionAnalysis[], project: string, sessionId: number): Promise<AnalysisFailureGroupReturn[]>

參數

傳回

在 LogStore 中為指定的 buildId 建立附件。

function createBuildAttachmentInLogStore(attachmentRequestModel: TestAttachmentRequestModel, project: string, buildId: number): Promise<void>

參數

傳回

在 TCM 資料存放區中建立 Environment 物件

function createEnvironment(environments: TestSessionEnvironment[], project: string): Promise<void>

參數

傳回

針對提供的 sessionId，在 TCM 資料存放區中建立環境、組態和計算機物件

function createEnvironmentAndMachine(sessionEnvironmentAndMachine: SessionEnvironmentAndMachine, project: string, sessionId: number): Promise<void>

參數

傳回

建立新的測試失敗類型

function createFailureType(testResultFailureType: TestResultFailureTypeRequestModel, project: string): Promise<TestResultFailureType>

參數

傳回

在指定會話的 TCM 資料存放區中建立 Notification 物件

function createNotification(notifications: TestSessionNotification[], project: string, sessionId: number): Promise<number[]>

參數

傳回

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>

參數

傳回

在 LogStore 中為指定的 runId 建立附件。

function createTestRunLogStoreAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestLogStoreAttachmentReference>

參數

傳回

在 TCM 數據存放區中建立 TestResultsSession 物件

function createTestSession(session: TestResultsSession, project: string): Promise<number>

參數

傳回

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

參數

傳回

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

參數

傳回

function deleteCustomFieldById(project: string, testExtensionFieldId: number): Promise<void>

參數

傳回

刪除具有指定 failureTypeId 的測試失敗類型

function deleteFailureType(project: string, failureTypeId: number): Promise<void>

參數

傳回

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

參數

傳回

function deleteTestResultAttachment(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<void>

參數

傳回

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

參數

傳回

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

參數

傳回

從 LogStore 刪除具有指定 runId 之指定檔名的附件。

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

參數

傳回

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

參數

傳回

function fetchSourceCodeCoverageReport(project: string, buildId: number): Promise<SourceViewBuildCoverage[]>

參數

傳回

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

參數

傳回

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

參數

傳回

http://（tfsserver）：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10&deltaBuildId=9 要求：組建標識符和差異組建標識符（選擇性）

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

參數

傳回

<p>取得定義上一次成功建置的涵蓋範圍狀態，選擇性地限定為特定分支</p>

function getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise<string>

參數

傳回

傳回測試失敗類型的清單。

function getFailureTypes(project: string): Promise<TestResultFailureType[]>

參數

傳回

取得指定檔案的檔案涵蓋範圍

function getFileLevelCodeCoverage(fileCoverageRequest: FileCoverageRequest, project: string): Promise<string>

參數

傳回

function getFlakyTestResultsByBuildDefinitionId(project: string, buildDefinitionId: number, minBuildCreatedDate: Date): Promise<TestCaseResult[]>

參數

傳回

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

參數

傳回

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

參數

傳回

擷取 TCM 資料存放區中的 TestResultsSession 通知物件

function getSessionNotifications(project: string, sessionId: number): Promise<TestSessionNotification[]>

參數

傳回

取得結果清單，其失敗與所提供的結果相符。

function getSimilarTestResults(project: string, runId: number, testResultId: number, testSubResultId: number, top?: number, continuationToken?: String): Promise<TestCaseResult[]>

參數

傳回

傳回測試反覆專案附件

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

參數

傳回

傳回測試反覆專案附件

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

參數

傳回

取得組建附件參考的清單

function getTestLogsForBuild(project: string, buildId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

參數

傳回

取得組建附件的SAS URI

function getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

參數

傳回

取得測試結果附件的SAS URI

function getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

參數

傳回

取得測試回合附件的SAS URI

function getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

參數

傳回

取得測試子附件的SAS URI

function getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

參數

傳回

取得測試結果的摘要。

function getTestPipelineMetrics(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, metricNames?: Metrics[], groupByNode?: boolean): Promise<PipelineTestMetrics>

參數

傳回

傳回測試結果附件

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

參數

傳回

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

參數

傳回

傳回測試結果附件

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

參數

傳回

function getTestResultById(project: string, runId: number, testResultId: 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 getTestResultLogs(project: string, runId: number, resultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

參數

傳回

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

參數

傳回

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

參數

傳回

取得結果清單。

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: String): Promise<PagedList<ShallowTestCaseResult>>

參數

傳回

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

參數

傳回

function getTestResultsByQueryWiql(queryModel: QueryModel, project: string, includeResultDetails?: boolean, includeIterationDetails?: boolean, skip?: number, top?: number): Promise<TestCaseResult[]>

參數

傳回

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

參數

傳回

取得 TestResultsSettings 數據

function getTestResultsSettings(project: string, settingsType?: TestResultsSettingsType): Promise<TestResultsSettings>

參數

傳回

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

參數

傳回

傳回測試回合附件

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

參數

傳回

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

參數

傳回

傳回測試回合附件

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

參數

傳回

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

參數

傳回

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

參數

傳回

取得測試回合附件參考清單

function getTestRunLogs(project: string, runId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

參數

傳回

從 LogStore 傳回具有指定 runId 之指定檔名的附件。

function getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise<ArrayBuffer>

參數

傳回

從 LogStore 傳回指定 runId 的附件清單。

function getTestRunLogStoreAttachments(project: string, runId: number): Promise<TestLogStoreAttachment[]>

參數

傳回

從 LogStore 傳回具有指定 runId 之指定檔名的附件。

function getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise<ArrayBuffer>

參數

傳回

取得測試回合訊息記錄

function getTestRunMessageLogs(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 getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>

參數

傳回

取得測試回合統計數據，當我們想要依結果取得回合摘要時使用。

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

參數

傳回

取得測試回合摘要，當我們想要依結果取得回合的摘要時使用。 測試回合應處於已完成狀態。

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

參數

傳回

擷取 TCM 資料存放區中的 TestResultsSession 元數據物件

function getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>

參數

傳回

擷取 TCM 資料存放區中的 TestResultsSession Layout 物件

function getTestSessionLayout(project: string, sessionId: string): Promise<any[]>

參數

傳回

擷取 TCM 資料存放區中的 TestResultsSession Layout 物件

function getTestSessionLayoutBySessionId(project: string, sessionId: number): Promise<any[]>

參數

傳回

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

參數

傳回

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 getTestSubResultLogs(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

參數

傳回

取得組建中的所有標記。

function getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>

參數

傳回

取得版本中的所有標籤。

function getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTag[]>

參數

傳回

取得組建中的所有標記。

function getTestTagSummaryForBuild(project: string, buildId: number): Promise<TestTagSummary>

參數

傳回

取得版本中的所有標籤。

function getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTagSummary>

參數

傳回

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(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

參數

傳回

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

參數

傳回

取得測試結果的摘要。

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): 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[]>

參數

傳回

根據篩選條件查詢測試結果 WorkItems

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

參數

傳回

建立和取得建置容器的 sas URI

function testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: TestLogStoreOperationType): Promise<TestLogStoreEndpointDetails>

參數

傳回

為結果建立空白檔案，並取得檔案的 Sas URI

function testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: TestLogType): Promise<TestLogStoreEndpointDetails>

參數

傳回

為執行建立空白檔案，並取得檔案的 Sas URI

function testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: TestLogStoreOperationType, filePath?: string, type?: TestLogType): Promise<TestLogStoreEndpointDetails>

參數

傳回

取得所有可用的群組詳細數據，並針對這些群組取得失敗和中止的結果。

function testResultsGroupDetails(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, shouldIncludeFailedAndAbortedResults?: boolean, queryGroupSummaryForInProgress?: boolean): Promise<TestResultsDetails>

參數

傳回

http://（tfsserver）：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10 要求：程式代碼涵蓋範圍摘要的 Json

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

參數

傳回

function updateCustomField(updateCustomTestField: CustomTestFieldUpdateDefinition, project: string): Promise<CustomTestFieldDefinition>

參數

傳回

更新測試結果的項目設定

function updatePipelinesTestSettings(testResultsUpdateSettings: TestResultsUpdateSettings, project: string): Promise<TestResultsSettings>

參數

傳回

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

參數

傳回

更新測試結果元數據的屬性

function updateTestResultsMetaData(testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput, project: string, testCaseReferenceId: number): Promise<TestResultMetaData>

參數

傳回

在 TCM 數據存放區中建立 TestResultsMRX 物件，以取得現有的測試結果

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

參數

傳回

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

參數

傳回

更新執行的標籤、可新增和刪除標籤

function updateTestRunTags(testTagsUpdateModel: TestTagsUpdateModel, project: string, runId: number): Promise<TestTag[]>

參數

傳回