TestResultsRestClient class

參考

套件:: azure-devops-extension-api

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

Extends: RestClientBase

建構函式

TestResultsRestClient(IVssRestClientOptions)

屬性

RESOURCE_AREA_ID

方法

addCustomFields(CustomTestFieldDefinition[], string)
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	將測試結果新增至測試回合會話
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createAnalysis(TestSessionAnalysis[], string, number)	在指定會話的 TCM 資料存放區中建立工作階段分析物件
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	在 LogStore 中為指定的 buildId 建立附件。
createEnvironment(TestSessionEnvironment[], string)	在 TCM 資料存放區中建立 Environment 物件
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	針對提供的 sessionId，在 TCM 資料存放區中建立環境、組態和計算機物件
createFailureType(TestResultFailureTypeRequestModel, string)	建立新的測試失敗類型
createNotification(TestSessionNotification[], string, number)	在指定會話的 TCM 資料存放區中建立 Notification 物件
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	在 LogStore 中為指定的 runId 建立附件。
createTestSession(TestResultsSession, string)	在 TCM 數據存放區中建立 TestResultsSession 物件
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
deleteCustomFieldById(string, number)
deleteFailureType(string, number)	刪除具有指定 failureTypeId 的測試失敗類型
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)	從 LogStore 刪除具有指定 runId 之指定檔名的附件。
deleteTestSettings(string, number)
fetchSourceCodeCoverageReport(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)
getCodeCoverageSummary(string, number, number)	http://（tfsserver）：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10&deltaBuildId=9 要求：組建標識符和差異組建標識符（選擇性）
getCoverageStatusBadge(string, string, string, string)	<p>取得定義上一次成功建置的涵蓋範圍狀態，選擇性地限定為特定分支</p>
getFailureTypes(string)	傳回測試失敗類型的清單。
getFileLevelCodeCoverage(FileCoverageRequest, string)	取得指定檔案的檔案涵蓋範圍
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	擷取 TCM 資料存放區中的 TestResultsSession 通知物件
getSimilarTestResults(string, number, number, number, number, String)	取得結果清單，其失敗與所提供的結果相符。
getTestIterationAttachmentContent(string, number, number, number, number)	傳回測試反覆專案附件
getTestIterationAttachmentZip(string, number, number, number, number)	傳回測試反覆專案附件
getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)	取得組建附件參考的清單
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	取得組建附件的SAS URI
getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)	取得測試結果附件的SAS URI
getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)	取得測試回合附件的SAS URI
getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)	取得測試子附件的SAS URI
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	取得測試結果的摘要。
getTestResultAttachmentContent(string, number, number, number)	傳回測試結果附件
getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)	傳回測試結果附件
getTestResultById(string, number, number, ResultDetails)
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)	取得測試結果附件參考清單
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)	取得結果清單。
getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)	取得 TestResultsSettings 數據
getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)	傳回測試回合附件
getTestRunAttachments(string, number)
getTestRunAttachmentZip(string, number, number)	傳回測試回合附件
getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)	取得測試回合附件參考清單
getTestRunLogStoreAttachmentContent(string, number, string)	從 LogStore 傳回具有指定 runId 之指定檔名的附件。
getTestRunLogStoreAttachments(string, number)	從 LogStore 傳回指定 runId 的附件清單。
getTestRunLogStoreAttachmentZip(string, number, string)	從 LogStore 傳回具有指定 runId 之指定檔名的附件。
getTestRunMessageLogs(string, number)	取得測試回合訊息記錄
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
getTestRunsBySessionId(string, number)	擷取與會話相關聯的測試回合
getTestRunStatistics(string, number)	取得測試回合統計數據，當我們想要依結果取得回合摘要時使用。
getTestRunSummaryByOutcome(string, number)	取得測試回合摘要，當我們想要依結果取得回合的摘要時使用。測試回合應處於已完成狀態。
getTestSession(string, number)	擷取 TCM 資料存放區中的 TestResultsSession 元數據物件
getTestSessionLayout(string, string)	擷取 TCM 資料存放區中的 TestResultsSession Layout 物件
getTestSessionLayoutBySessionId(string, number)	擷取 TCM 資料存放區中的 TestResultsSession Layout 物件
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	傳回測試子結果附件
getTestSubResultAttachments(string, number, number, number)	傳回測試子結果的附件參考。
getTestSubResultAttachmentZip(string, number, number, number, number)	傳回測試子結果附件
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	取得測試子附件參考清單
getTestTagsForBuild(string, number)	取得組建中的所有標記。
getTestTagsForRelease(string, number, number)	取得版本中的所有標籤。
getTestTagSummaryForBuild(string, number)	取得組建中的所有標記。
getTestTagSummaryForRelease(string, number, number)	取得版本中的所有標籤。
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	使用 TestHistoryQuery 取得測試方法的歷程記錄
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)	取得對應testcasereferenceId的測試結果元數據詳細數據清單
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)	取得測試結果的摘要。
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	根據篩選條件查詢測試結果 WorkItems
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)	根據篩選條件執行查詢測試。必要欄位為 minLastUpdatedDate 和 maxLastUpdatedDate。
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	建立和取得建置容器的 sas URI
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	為結果建立空白檔案，並取得檔案的 Sas URI
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	為執行建立空白檔案，並取得檔案的 Sas URI
testResultsGroupDetails(string, number, string, string, string, boolean, boolean)	取得所有可用的群組詳細數據，並針對這些群組取得失敗和中止的結果。
updateCodeCoverageSummary(string, number, CodeCoverageData)	http://（tfsserver）：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10 要求：程式代碼涵蓋範圍摘要的 Json
updateCustomField(CustomTestFieldUpdateDefinition, string)
updatePipelinesTestSettings(TestResultsUpdateSettings, string)	更新測試結果的項目設定
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	更新測試結果元數據的屬性
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	在 TCM 數據存放區中建立 TestResultsMRX 物件，以取得現有的測試結果
updateTestRun(RunUpdateModel, string, number)
updateTestRunTags(TestTagsUpdateModel, string, number)	更新執行的標籤、可新增和刪除標籤

建構函式詳細資料

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

參數

options: IVssRestClientOptions

屬性詳細資料

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

屬性值

string

方法詳細資料

addCustomFields(CustomTestFieldDefinition[], string)

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

參數

newFields: CustomTestFieldDefinition[]

project: string

項目識別碼或項目名稱

傳回

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

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

參數

results: TestCaseResult[]

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

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

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

參數

results: TestCaseResult[]

project: string

項目識別碼或項目名稱

runId: number

測試回合的 RunId

傳回

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

參數

workItemToTestLinks: WorkItemToTestLinks

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemToTestLinks>

createAnalysis(TestSessionAnalysis[], string, number)

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

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

參數

analysis: TestSessionAnalysis[]

會話分析詳細數據

project: string

項目識別碼或項目名稱

sessionId: number

要新增通知的會話標識碼

傳回

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

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

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

參數

attachmentRequestModel: TestAttachmentRequestModel

包含附件資訊，例如數據流、檔名、批注、attachmentType

project: string

項目識別碼或項目名稱

buildId: number

BuildId

傳回

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

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

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

參數

environments: TestSessionEnvironment[]

Received Environment 物件。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

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

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

參數

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

項目識別碼或項目名稱

sessionId: number

傳回

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

建立新的測試失敗類型

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

參數

testResultFailureType: TestResultFailureTypeRequestModel

project: string

項目識別碼或項目名稱

傳回

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

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

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

參數

notifications: TestSessionNotification[]

要為指定的 sessionId 新增的 Notification（s）

project: string

項目識別碼或項目名稱

sessionId: number

要新增通知的會話標識碼

傳回

Promise<number[]>

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

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

iterationId: number

actionPath: string

傳回

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

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

參數

attachmentRequestModel: TestAttachmentRequestModel

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

傳回

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

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

參數

testRun: RunCreateModel

project: string

項目識別碼或項目名稱

傳回

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

參數

attachmentRequestModel: TestAttachmentRequestModel

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

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

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

參數

attachmentRequestModel: TestAttachmentRequestModel

包含附件資訊，例如數據流、檔名、批注、attachmentType

project: string

項目識別碼或項目名稱

runId: number

測試 RunId

傳回

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

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

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

參數

session: TestResultsSession

已接收的會話物件。

project: string

項目識別碼或項目名稱

傳回

Promise<number>

createTestSettings(TestSettings, string)

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

參數

testSettings: TestSettings

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

runId: number

testCaseResultId: number

testSubResultId: number

傳回

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

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

參數

project: string

項目識別碼或項目名稱

testExtensionFieldId: number

傳回

Promise<void>

deleteFailureType(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

failureTypeId: number

傳回

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

參數

project: string

項目識別碼或項目名稱

testName: string

workItemId: number

傳回

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

傳回

Promise<void>

deleteTestRun(string, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<void>

deleteTestRunAttachment(string, number, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

attachmentId: number

傳回

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

測試 RunId

filename: string

附件 FileName

傳回

Promise<void>

deleteTestSettings(string, number)

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

參數

project: string

項目識別碼或項目名稱

testSettingsId: number

傳回

Promise<void>

fetchSourceCodeCoverageReport(string, number)

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

參數

project: string

項目識別碼或項目名稱

buildId: number

傳回

Promise<SourceViewBuildCoverage[]>

getBugsLinkedToTestResult(string, number, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

傳回

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

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

參數

project: string

項目識別碼或項目名稱

buildId: number

flags: number

傳回

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

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

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

參數

project: string

項目識別碼或項目名稱

buildId: number

deltaBuildId: number

傳回

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

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

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

參數

project: string

項目識別碼或項目名稱

definition: string

定義的識別碼或名稱。

branchName: string

分支名稱。

label: string

要取代徽章左側默認文字的 String。

傳回

Promise<string>

getFailureTypes(string)

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

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

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

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

參數

fileCoverageRequest: FileCoverageRequest

具有提取要求反覆項目的檔案詳細數據

project: string

項目識別碼或項目名稱

傳回

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

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

參數

project: string

項目識別碼或項目名稱

buildDefinitionId: number

minBuildCreatedDate: Date

傳回

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestCaseResult[]>

getResultGroupsByBuild(string, number, string, string[], string)

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

參數

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

傳回

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

sessionId: number

要取得通知的TestResults會話標識碼。

傳回

Promise<TestSessionNotification[]>

getSimilarTestResults(string, number, number, number, number, String)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

測試回合的標識碼

testResultId: number

測試回合內的測試結果標識碼

testSubResultId: number

測試結果內的 subresult 識別符

top: number

要傳回的結果數目上限

continuationToken: String

要傳遞 continuationToken 的標頭

傳回

Promise<TestCaseResult[]>

getTestIterationAttachmentContent(string, number, number, number, number)

傳回測試反覆專案附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

傳回

Promise<ArrayBuffer>

getTestIterationAttachmentZip(string, number, number, number, number)

傳回測試反覆專案附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

傳回

Promise<ArrayBuffer>

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

取得組建附件參考的清單

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

參數

project: string

項目識別碼或項目名稱

buildId: number

要取得的組建標識碼

type: TestLogType

要取得的附件類型

directoryPath: string

需要附件的目錄路徑

fileNamePrefix: string

用來篩選附件清單的檔名前置詞

fetchMetaData: boolean

默認值為 false，如果需要元數據，請設定

top: number

要傳回的測試附件參考數目

continuationToken: String

要傳遞 continuationToken 的標頭

傳回

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

取得組建附件的SAS URI

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

參數

project: string

項目識別碼或項目名稱

build: number

要取得的組建標識碼

type: TestLogType

檔案類型

filePath: string

需要 sas URI 的 filePath

傳回

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

取得測試結果附件的SAS URI

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

參數

project: string

項目識別碼或項目名稱

runId: number

包含結果的測試回合識別碼

resultId: number

需要下載其檔案之測試結果的標識碼

type: TestLogType

檔案類型

filePath: string

需要 sas URI 的 filePath

傳回

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

取得測試回合附件的SAS URI

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

參數

project: string

項目識別碼或項目名稱

runId: number

必須下載其檔案的測試回合標識碼

type: TestLogType

檔案類型

filePath: string

需要 sas URI 的 filePath

傳回

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

取得測試子附件的SAS URI

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

參數

project: string

項目識別碼或項目名稱

runId: number

包含結果的測試回合識別碼

resultId: number

包含 subresult 之測試結果的標識碼

subResultId: number

需要其檔案 sas uri 的測試子實例識別碼

type: TestLogType

檔案類型

filePath: string

需要 sas URI 的 filePath

傳回

Promise<TestLogStoreEndpointDetails>

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

取得測試結果的摘要。

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

參數

project: string

項目識別碼或項目名稱

pipelineId: number

管線標識碼。這與組建標識碼相同。

stageName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

phaseName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

jobName: string

YAML 中的矩陣會產生具有矩陣中不同輸入之作業的複本。 JobName 是這些輸入的名稱。名稱支援的長度上限為 256 個字元。

metricNames: Metrics[]

groupByNode: boolean

pipleine 繼承式每個節點的群組摘要

傳回

Promise<PipelineTestMetrics>

getTestResultAttachmentContent(string, number, number, number)

傳回測試結果附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

傳回

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

傳回

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

傳回測試結果附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

傳回

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

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

參數

project: string

項目識別碼或項目名稱

runId: number

testResultId: number

detailsToInclude: ResultDetails

傳回

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

項目識別碼或項目名稱

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

項目識別碼或項目名稱

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

傳回

Promise<TestResultsDetails>

getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

取得測試結果附件參考清單

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

參數

project: string

項目識別碼或項目名稱

runId: number

包含結果的測試回合識別碼

resultId: number

測試結果的標識碼

type: TestLogType

要取得的附件類型

directoryPath: string

要取得之附件的目錄路徑

fileNamePrefix: string

用來篩選附件清單的檔名前置詞

fetchMetaData: boolean

默認值為 false，如果需要元數據，請設定

top: number

要傳回的附件參考數

continuationToken: String

要傳遞 continuationToken 的標頭

傳回

Promise<PagedList<TestLog>>

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

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

參數

project: string

項目識別碼或項目名稱

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

傳回

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

項目識別碼或項目名稱

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

傳回

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)

取得結果清單。

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

參數

project: string

項目識別碼或項目名稱

pipelineId: number

管線標識碼。這與組建標識碼相同。

stageName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

phaseName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

jobName: string

YAML 中的矩陣會產生具有矩陣中不同輸入之作業的複本。 JobName 是這些輸入的名稱。名稱支援的長度上限為 256 個字元。

outcomes: TestOutcome[]

結果結果的清單

top: number

要傳回的結果數目上限

continuationToken: String

要傳遞 continuationToken 的標頭

傳回

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

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

參數

query: TestResultsQuery

project: string

項目識別碼或項目名稱

傳回

Promise<TestResultsQuery>

getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)

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

參數

queryModel: QueryModel

project: string

項目識別碼或項目名稱

includeResultDetails: boolean

includeIterationDetails: boolean

skip: number

top: number

傳回

Promise<TestCaseResult[]>

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

項目識別碼或項目名稱

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

傳回

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsSettings(string, TestResultsSettingsType)

取得 TestResultsSettings 數據

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

參數

project: string

項目識別碼或項目名稱

settingsType: TestResultsSettingsType

傳回

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

傳回

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

傳回測試回合附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

attachmentId: number

傳回

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

傳回測試回合附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

attachmentId: number

傳回

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

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

參數

project: string

項目識別碼或項目名稱

runId: number

includeDetails: boolean

includeTags: boolean

傳回

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

參數

project: string

項目識別碼或項目名稱

runId: number

flags: number

傳回

Promise<TestRunCoverage[]>

getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

測試回合的標識碼

type: TestLogType

要取得的附件類型

directoryPath: string

需要附件的目錄路徑

fileNamePrefix: string

用來篩選附件清單的檔名前置詞

fetchMetaData: boolean

默認值為 false，如果需要元數據，請設定

top: number

要傳回的附件參考數目

continuationToken: String

要傳遞 continuationToken 的標頭

傳回

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

測試 RunId

filename: string

附件 FileName

傳回

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

測試 RunId

傳回

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

測試 RunId

filename: string

附件 FileName

傳回

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

取得測試回合訊息記錄

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

參數

project: string

項目識別碼或項目名稱

runId: number

要取得的執行標識碼。

傳回

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

項目識別碼或項目名稱

buildUri: string

owner: string

tmiRunId: string

planId: number

includeRunDetails: boolean

automated: boolean

skip: number

top: number

傳回

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

擷取與會話相關聯的測試回合

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

參數

project: string

項目識別碼或項目名稱

sessionId: number

要取得測試回合的 TestResults 會話識別碼。

傳回

Promise<number[]>

getTestRunStatistics(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

要取得的執行標識碼。

傳回

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

要取得的執行標識碼。

傳回

Promise<TestRunStatistic>

getTestSession(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

buildId: number

傳回

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

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

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

參數

project: string

項目識別碼或項目名稱

sessionId: string

傳回

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

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

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

參數

project: string

項目識別碼或項目名稱

sessionId: number

擷取會話物件。

傳回

Promise<any[]>

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

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

參數

project: string

項目識別碼或項目名稱

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

傳回

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

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

參數

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

傳回

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

傳回測試子結果的附件參考。

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

testSubResultId: number

傳回

Promise<TestAttachment[]>

getTestSubResultAttachmentZip(string, number, number, number, number)

傳回測試子結果附件

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

參數

project: string

項目識別碼或項目名稱

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

傳回

Promise<ArrayBuffer>

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

取得測試子附件參考清單

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

參數

project: string

項目識別碼或項目名稱

runId: number

包含結果的測試回合識別碼

resultId: number

包含 subresult 之測試結果的標識碼

subResultId: number

測試子實例的標識碼

type: TestLogType

要取得的附件類型

directoryPath: string

要取得之附件的目錄路徑

fileNamePrefix: string

用來篩選附件清單的檔名前置詞

fetchMetaData: boolean

默認值為 false，如果需要元數據，請設定

top: number

要傳回的附件參考數目

continuationToken: String

要傳遞 continuationToken 的標頭

傳回

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

取得組建中的所有標記。

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

參數

project: string

項目識別碼或項目名稱

buildId: number

組建標識碼

傳回

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

取得版本中的所有標籤。

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

參數

project: string

項目識別碼或項目名稱

releaseId: number

版本標識碼

releaseEnvId: number

發行環境標識碼

傳回

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

取得組建中的所有標記。

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

參數

project: string

項目識別碼或項目名稱

buildId: number

組建標識碼

傳回

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

取得版本中的所有標籤。

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

參數

project: string

項目識別碼或項目名稱

releaseId: number

版本標識碼

releaseEnvId: number

發行環境標識碼

傳回

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

參數

document: TestResultDocument

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

參數

project: string

項目識別碼或項目名稱

scopeFilter: CustomTestFieldScope

傳回

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

參數

filter: TestResultTrendFilter

project: string

項目識別碼或項目名稱

傳回

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

參數

filter: TestResultTrendFilter

project: string

項目識別碼或項目名稱

傳回

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

使用 TestHistoryQuery 取得測試方法的歷程記錄

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

參數

filter: TestHistoryQuery

TestHistoryQuery 以取得歷程記錄

project: string

項目識別碼或項目名稱

傳回

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

參數

project: string

項目識別碼或項目名稱

testName: string

傳回

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

參數

filter: ResultsFilter

project: string

項目識別碼或項目名稱

傳回

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

取得對應testcasereferenceId的測試結果元數據詳細數據清單

function queryTestResultsMetaData(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

參數

testCaseReferenceIds: string[]

要查詢之測試結果的 TestCaseReference Ids，以逗號分隔的有效標識符清單（限制標識符為 200）。

project: string

項目識別碼或項目名稱

detailsToInclude: ResultMetaDataDetails

要包含在測試結果元數據中的詳細數據。預設值為 None。其他值為 FlakyIdentifiers。

傳回

Promise<TestResultMetaData[]>

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)

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

參數

project: string

項目識別碼或項目名稱

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

傳回

Promise<TestResultSummary>

queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

取得測試結果的摘要。

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): Promise<TestResultSummary>

參數

project: string

項目識別碼或項目名稱

pipelineId: number

管線標識碼。這與組建標識碼相同。

stageName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

phaseName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

jobName: string

YAML 中的矩陣會產生具有矩陣中不同輸入之作業的複本。 JobName 是這些輸入的名稱。名稱支援的長度上限為 256 個字元。

includeFailureDetails: boolean

如果 true 傳回失敗深入解析

傳回

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

項目識別碼或項目名稱

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

傳回

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

參數

releases: ReleaseReference[]

project: string

項目識別碼或項目名稱

傳回

Promise<TestResultSummary[]>

queryTestResultWorkItems(string, string, string, number, Date, number, number)

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

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

參數

project: string

項目識別碼或項目名稱

workItemCategory: string

可以接受值Microsoft.BugCategory 或 all（用於取得所有工作專案）

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

項目識別碼或項目名稱

minLastUpdatedDate: Date

要查詢的執行上次修改日期下限（必要）。

maxLastUpdatedDate: Date

要查詢的執行上次修改日期上限（強制，最小和最大日期之間的差異最多 7 天）。

state: TestRunState

要查詢的執行目前狀態。

planIds: number[]

要查詢的執行計劃識別碼，以逗號分隔的有效標識符清單。

isAutomated: boolean

要查詢的執行自動化類型。

publishContext: TestRunPublishContext

要查詢之執行的 PublishContext。

buildIds: number[]

要查詢的執行組建識別碼，並以逗號分隔的有效標識符清單。

buildDefIds: number[]

要查詢的執行定義識別碼，以逗號分隔的有效標識符清單。

branchName: string

要查詢的執行來源分支名稱。

releaseIds: number[]

要查詢之執行的版本識別碼，以逗號分隔的有效標識符清單。

releaseDefIds: number[]

要查詢之執行的版本定義識別碼，以逗號分隔的有效標識碼清單。

releaseEnvIds: number[]

要查詢的執行環境識別碼，以逗號分隔的有效標識符清單。

releaseEnvDefIds: number[]

發行要查詢的執行環境定義識別碼，並以逗號分隔的有效標識符清單。

runTitle: string

執行要查詢的執行標題。

top: number

要查詢的執行數目。限制為 100

continuationToken: string

continuationToken 從前一個批次接收，或第一個批次的 null。使用者不應該建立它（或改變，如果從最後一批收到的話）。

傳回

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

參數

resultsContext: TestResultsContext

project: string

項目識別碼或項目名稱

workItemIds: number[]

傳回

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

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

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

參數

project: string

項目識別碼或項目名稱

buildId: number

要取得的組建標識碼

testLogStoreOperationType: TestLogStoreOperationType

使用 sas uri 執行的作業類型

傳回

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

包含結果的測試回合識別碼

resultId: number

包含子結果的測試結果標識碼

subResultId: number

需要其檔案 sas URI 的測試子結果標識碼

filePath: string

需要 sas URI 的子結果內的檔案路徑

type: TestLogType

要下載的文件類型

傳回

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

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

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

參數

project: string

項目識別碼或項目名稱

runId: number

執行標識碼以取得端點詳細數據

testLogStoreOperationType: TestLogStoreOperationType

使用 sas uri 執行的作業類型

filePath: string

建立空白檔案的檔案路徑

type: TestLogType

默認值為 GeneralAttachment，要建立的空白檔案類型

傳回

Promise<TestLogStoreEndpointDetails>

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

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

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

參數

project: string

項目識別碼或項目名稱

pipelineId: number

管線標識碼。這與組建標識碼相同。

stageName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

phaseName: string

階段的名稱。名稱支援的長度上限為 256 個字元。

jobName: string

YAML 中的矩陣會產生具有矩陣中不同輸入之作業的複本。 JobName 是這些輸入的名稱。名稱支援的長度上限為 256 個字元。

shouldIncludeFailedAndAbortedResults: boolean

如果為 true，則會傳回每個測試群組失敗和中止結果的標識碼

queryGroupSummaryForInProgress: boolean

如果為 true，它也會計算 InProgress 執行的摘要。

傳回

Promise<TestResultsDetails>

updateCodeCoverageSummary(string, number, CodeCoverageData)

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

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

參數

project: string

項目識別碼或項目名稱

buildId: number

coverageData: CodeCoverageData

傳回

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

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

參數

updateCustomTestField: CustomTestFieldUpdateDefinition

project: string

項目識別碼或項目名稱

傳回

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

更新測試結果的項目設定

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

參數

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

項目識別碼或項目名稱

傳回

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

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

參數

results: TestCaseResult[]

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

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

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

參數

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData 更新輸入 TestResultMetaDataUpdateInput

project: string

項目識別碼或項目名稱

testCaseReferenceId: number

要更新之測試結果的 TestCaseReference 識別符。

傳回

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

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

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

參數

results: TestCaseResult[]

結果物件，只有測試結果 MRX 屬性和現有的 testResultId

project: string

項目識別碼或項目名稱

runId: number

測試回合的 RunId

傳回

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

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

參數

runUpdateModel: RunUpdateModel

project: string

項目識別碼或項目名稱

runId: number

傳回

Promise<TestRun>

updateTestRunTags(TestTagsUpdateModel, string, number)

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

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

參數

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

項目識別碼或項目名稱

runId: number

RunId 的執行

傳回

Promise<TestTag[]>

共用方式為

TestResultsRestClient class

建構函式

屬性

方法

建構函式詳細資料

TestResultsRestClient(IVssRestClientOptions)

參數

屬性詳細資料

RESOURCE_AREA_ID

屬性值

方法詳細資料

addCustomFields(CustomTestFieldDefinition[], string)

參數

傳回

addTestResultsToTestRun(TestCaseResult[], string, number)

參數

傳回

addTestResultsToTestRunSession(TestCaseResult[], string, number)

參數

傳回

addWorkItemToTestLinks(WorkItemToTestLinks, string)

參數

傳回

createAnalysis(TestSessionAnalysis[], string, number)

參數

傳回

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

參數

傳回

createEnvironment(TestSessionEnvironment[], string)

參數

傳回

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

參數

傳回

createFailureType(TestResultFailureTypeRequestModel, string)

參數

傳回

createNotification(TestSessionNotification[], string, number)

參數

傳回

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

參數

傳回

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

參數

傳回

createTestRun(RunCreateModel, string)

參數

傳回

createTestRunAttachment(TestAttachmentRequestModel, string, number)

參數

傳回

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

參數

傳回

createTestSession(TestResultsSession, string)

參數

傳回

createTestSettings(TestSettings, string)

參數

傳回

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

參數

傳回

deleteCustomFieldById(string, number)

參數

傳回

deleteFailureType(string, number)

參數

傳回

deleteTestMethodToWorkItemLink(string, string, number)

參數

傳回

deleteTestResultAttachment(string, number, number, number)

參數

傳回

deleteTestRun(string, number)

參數