TestRestClient class

套件:: azure-devops-extension-api

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

Extends: RestClientBase

建構函式

屬性

方法

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)	將測試案例新增至套件。
addTestResultsToTestRun(TestCaseResult[], string, number)	將測試結果新增至測試回合。
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)	附加檔案以測試步驟結果
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)	將檔案附加至測試結果。
createTestRun(RunCreateModel, string)	建立新的測試回合。
createTestRunAttachment(TestAttachmentRequestModel, string, number)	將檔案附加至測試回合。
createTestSession(TestSession, TeamContext)	建立測試會話
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)	將檔案附加至測試結果
deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)	刪除測試案例。
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)	依標識碼刪除測試回合。
deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)	取得組建的程式代碼涵蓋範圍數據。
getCodeCoverageSummary(string, number, number)	取得組建的程式代碼涵蓋範圍摘要。
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)	取得測試點。
getPoints(string, number, number, string, string, string, string, boolean, number, number)	取得測試點清單。
getPointsByQuery(TestPointsQuery, string, number, number)	使用查詢取得測試點。
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)	取得測試結果保留設定
getTestCaseById(string, number, number, number)	在測試套件中取得具有測試案例標識碼的特定測試案例。
getTestCases(string, number, number)	取得套件中的所有測試案例。
getTestIteration(string, number, number, number, boolean)	取得結果的反覆專案
getTestIterations(string, number, number, 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)
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])	取得測試回合的測試結果。
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)	此 API 會依標識碼傳回結果，其中包含特定自動化測試方法的指定/趨勢字段。我們仍在改善此 API，但尚未完成適當的簽章和合約。
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)	依標識碼下載測試回合附件。
getTestRunAttachments(string, number)	取得測試回合附件參考的清單。
getTestRunAttachmentZip(string, number, number)	依標識碼下載測試回合附件。
getTestRunById(string, number, boolean)	依其標識碼取得測試回合。
getTestRunCodeCoverage(string, number, number)	取得測試回合的程式代碼涵蓋範圍數據
getTestRunLogs(string, number)	取得測試回合訊息記錄
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)	取得測試回合清單。
getTestRunStatistics(string, number)	取得測試回合統計數據，當我們想要依結果取得回合摘要時使用。
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)	取得測試會話的清單
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	下載測試子結果附件
getTestSubResultAttachments(string, number, number, number)	取得測試子結果附件的清單
getTestSubResultAttachmentZip(string, number, number, number, number)	下載測試子結果附件
processSuitesForStaging(StagedSuitesRequestModel, string, 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)	取得對應testcasereferenceId的測試結果元數據詳細數據清單
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)	根據篩選條件執行查詢測試。必要欄位為 minLastUpdatedDate 和 maxLastUpdatedDate。
queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)	與測試案例相關聯的測試點會從測試套件中移除。測試案例工作專案不會從系統中刪除。請參閱測試案例資源，以永久刪除測試案例。
updateCodeCoverageSummary(CodeCoverageData, string, number)	http://（tfsserver）：8080/tfs/DefaultCollection/_apis/test/CodeCoverage？buildId=10 要求：程式代碼涵蓋範圍摘要的 Json
updateResultRetentionSettings(ResultRetentionSettings, string)	更新測試結果保留設定
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)	更新套件中測試案例關聯的屬性。
updateTestPoints(PointUpdateModel, string, number, number, string)	更新測試點。
updateTestResults(TestCaseResult[], string, number)	更新測試回合中的測試結果。
updateTestRun(RunUpdateModel, string, number)	依標識碼更新測試回合。
updateTestSession(TestSession, TeamContext)	更新測試會話

建構函式詳細資料

TestRestClient(IVssRestClientOptions)

new TestRestClient(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[]>

addTestCasesToSuite(string, number, number, string)

將測試案例新增至套件。

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

參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

必須加入測試案例的測試套件識別碼。

testCaseIds: string

要新增至套件的測試案例標識碼。標識碼會以逗號分隔格式指定。

傳回

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

將測試結果新增至測試回合。

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

參數

results: TestCaseResult[]

要新增的測試結果清單。

project: string

項目識別碼或項目名稱

runId: number

測試要新增之測試結果的回合標識碼。

傳回

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

參數

workItemToTestLinks: WorkItemToTestLinks

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

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

附件詳細數據 TestAttachmentRequestModel

project: string

項目識別碼或項目名稱

runId: number

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

testCaseResultId: number

必須上傳附件之測試結果的標識碼。

傳回

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

建立新的測試回合。

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

參數

testRun: RunCreateModel

執行詳細數據 RunCreateModel

project: string

項目識別碼或項目名稱

傳回

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

將檔案附加至測試回合。

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

參數

attachmentRequestModel: TestAttachmentRequestModel

附件詳細數據 TestAttachmentRequestModel

project: string

項目識別碼或項目名稱

runId: number

必須上傳附件的測試回合標識碼。

傳回

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

項目識別碼或項目名稱

傳回

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>

deleteSharedParameter(string, number)

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

參數

project: string

項目識別碼或項目名稱

sharedParameterId: number

傳回

Promise<void>

deleteSharedStep(string, number)

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

參數

project: string

項目識別碼或項目名稱

sharedStepId: number

傳回

Promise<void>

deleteTestCase(string, number)

刪除測試案例。

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

參數

project: string

項目識別碼或項目名稱

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

deleteTestRun(string, number)

依標識碼刪除測試回合。

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

參數

project: string

項目識別碼或項目名稱

runId: number

要刪除的執行識別碼。

傳回

Promise<void>

deleteTestSettings(string, number)

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

參數

project: string

項目識別碼或項目名稱

testSettingsId: number

傳回

Promise<void>

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

旗標的值會決定要擷取的程式代碼涵蓋範圍詳細數據層級。旗標是加法的。模組的預期值為 1，針對函式為 2，BlockData 則為 4。

傳回

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

取得組建的程式代碼涵蓋範圍摘要。

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

參數

project: string

項目識別碼或項目名稱

buildId: number

需要擷取程式代碼涵蓋範圍數據的組建標識碼。

deltaBuildId: number

差異組建識別碼（選擇性）

傳回

Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

參數

workItemQuery: LinkedWorkItemsQuery

project: string

項目識別碼或項目名稱

傳回

Promise<LinkedWorkItemsQueryResult[]>

getPoint(string, number, number, number, string)

取得測試點。

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

參數

project: string

項目識別碼或項目名稱

planId: number

測試計劃的標識碼。

suiteId: number

包含點的套件識別碼。

pointIds: number

要取得的測試點標識碼。

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

項目識別碼或項目名稱

planId: number

測試計劃的標識碼。

suiteId: number

包含點的套件識別碼。

witFields: string

以逗號分隔的工作專案功能變數名稱清單。

configurationId: string

取得特定組態的測試點。

testCaseId: string

取得特定測試案例的測試點，在未設定 configurationId 時有效。

testPointIds: string

取得測試點以逗號分隔的測試點標識符清單，只有在未設定 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

項目識別碼或項目名稱

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

項目識別碼或項目名稱

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

getResultRetentionSettings(string)

取得測試結果保留設定

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<ResultRetentionSettings>

getTestCaseById(string, number, number, number)

在測試套件中取得具有測試案例標識碼的特定測試案例。

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

參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

包含測試案例的套件識別碼。

testCaseIds: number

要取得的測試案例標識碼。

傳回

Promise<SuiteTestCase>

getTestCases(string, number, number)

取得套件中的所有測試案例。

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

參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

要取得的套件標識碼。

傳回

Promise<SuiteTestCase[]>

getTestIteration(string, number, number, number, boolean)

取得結果的反覆專案

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

參數

project: string

項目識別碼或項目名稱

runId: number

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

testCaseResultId: number

包含反覆項目的測試結果標識碼。

iterationId: number

測試結果反覆運算的標識碼。

includeActionResults: boolean

包含測試反覆專案中所執行之每個動作的結果詳細數據。 ActionResults 是指執行手動測試時所執行之測試步驟的結果（通過/失敗）。包含 ActionResults 旗標可取得 actionResults 區段中測試步驟的結果，以及每個測試反覆專案之 parameters 區段中的測試參數。

傳回

Promise<TestIterationDetailsModel>

getTestIterations(string, number, number, boolean)

取得結果的反覆專案

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

參數

project: string

項目識別碼或項目名稱

runId: number

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

testCaseResultId: number

包含反覆項目的測試結果標識碼。

includeActionResults: boolean

傳回

Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent(string, number, number, number)

依標識碼下載測試結果附件。

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

參數

project: string

項目識別碼或項目名稱

runId: number

包含 testCaseResultId 的測試回合識別碼。

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 的測試回合識別碼。

testCaseResultId: number

必須下載其附件之測試結果的標識碼。

attachmentId: number

要下載之測試結果附件的標識碼。

傳回

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

取得測試回合的測試結果。

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

參數

project: string

項目識別碼或項目名稱

runId: number

要擷取之測試結果的測試回合標識碼。

testCaseResultId: number

測試結果標識碼。

detailsToInclude: ResultDetails

要包含在測試結果中的詳細數據。預設值為 None。其他值為反覆專案、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

項目識別碼或項目名稱

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>

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

項目識別碼或項目名稱

runId: number

要擷取之測試結果的測試回合標識碼。

detailsToInclude: ResultDetails

要包含在測試結果中的詳細數據。預設值為 None。其他值為反覆專案和 WorkItems。

skip: number

要從頭略過的測試結果數目。

top: number

要傳回的測試結果數目。當 detailsToInclude 為 None，否則為 200 時，最大值為 1000。

outcomes: TestOutcome[]

以逗號分隔的測試結果清單來篩選測試結果。

傳回

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

getTestResultsByQuery(TestResultsQuery, string)

此 API 會依標識碼傳回結果，其中包含特定自動化測試方法的指定/趨勢字段。我們仍在改善此 API，但尚未完成適當的簽章和合約。

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

參數

query: TestResultsQuery

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

傳回

Promise<PagedList<ShallowTestCaseResult>>

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)

依其標識碼取得測試回合。

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

參數

project: string

項目識別碼或項目名稱

runId: number

要取得的執行標識碼。

includeDetails: boolean

默認值為 true。其中包含執行統計數據、發行、組建、測試環境、後續程序狀態等詳細數據。

傳回

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

取得測試回合的程式代碼涵蓋範圍數據

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

參數

project: string

項目識別碼或項目名稱

runId: number

需要擷取程式代碼涵蓋範圍數據的測試回合標識碼。

flags: number

旗標的值會決定要擷取的程式代碼涵蓋範圍詳細數據層級。旗標是加法的。模組的預期值為 1，針對函式為 2，BlockData 則為 4。

傳回

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

取得測試回合訊息記錄

function getTestRunLogs(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

執行所使用的組建URI。

owner: string

執行擁有者的小組基礎標識碼。

tmiRunId: string

planId: number

執行所屬的測試計劃標識碼。

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

項目識別碼或項目名稱

runId: number

要取得的執行標識碼。

傳回

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

項目識別碼或項目名稱

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>

processSuitesForStaging(StagedSuitesRequestModel, string, number)

處理測試套件的集合，並傳回包含套件和測試案例詳細資料的回應模型。

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

參數

request: StagedSuitesRequestModel

包含要處理之測試套件的要求模型。不能為空值。

project: string

項目識別碼或項目名稱

workItemId: number

傳回

Promise<StagedSuitesResponseModel>

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)

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

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

參數

testReferenceIds: string[]

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

project: string

項目識別碼或項目名稱

傳回

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>

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)

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

參數

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

minLastUpdatedDate: Date

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

maxLastUpdatedDate: Date

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

state: TestRunState

要查詢的執行目前狀態。

planIds: number[]

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

isAutomated: boolean

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

publishContext: TestRunPublishContext

要查詢之執行的 PublishContext。

buildIds: number[]

要查詢的執行組建標識碼，以逗號分隔的有效標識符清單（限制標識元 10）。

buildDefIds: number[]

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

branchName: string

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

releaseIds: number[]

要查詢的執行版本識別碼，以逗號分隔的有效標識符清單（限制標識元 10）。

releaseDefIds: number[]

要查詢的執行版本定義識別碼，以逗號分隔的有效標識符清單（限制標識元 10）。

releaseEnvIds: number[]

要查詢的執行環境標識碼，以逗號分隔的有效標識符清單（限制標識元 10 的限制）。

releaseEnvDefIds: number[]

要查詢的執行環境定義識別碼，以逗號分隔的有效標識符清單（限制標識元 10 的限制）。

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

removeTestCasesFromSuiteUrl(string, number, number, string)

與測試案例相關聯的測試點會從測試套件中移除。測試案例工作專案不會從系統中刪除。請參閱測試案例資源，以永久刪除測試案例。

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

參數

project: string

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

要取得的套件標識碼。

testCaseIds: string

要從套件中移除的測試案例標識碼。

傳回

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

項目識別碼或項目名稱

buildId: number

傳回

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

更新測試結果保留設定

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

參數

retentionSettings: ResultRetentionSettings

要更新的測試結果保留設定詳細數據

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

planId: number

包含套件的測試計劃標識碼。

suiteId: number

必須加入測試案例的測試套件識別碼。

testCaseIds: string

要新增至套件的測試案例標識碼。標識碼會以逗號分隔格式指定。

傳回

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

項目識別碼或項目名稱

planId: number

測試計劃的標識碼。

suiteId: number

包含點的套件識別碼。

pointIds: string

要取得的測試點標識碼。使用逗號分隔的標識符清單來更新多個測試點。

傳回

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

更新測試回合中的測試結果。

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

參數

results: TestCaseResult[]

要更新的測試結果清單。

project: string

項目識別碼或項目名稱

runId: number

要更新其測試結果的測試回合標識碼。

傳回

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

依標識碼更新測試回合。

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

參數

runUpdateModel: RunUpdateModel

執行詳細數據 RunUpdateModel

project: string

項目識別碼或項目名稱

runId: number

要更新的執行標識碼。

傳回

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

更新測試會話

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

參數

testSession: TestSession

更新的測試會話詳細數據

teamContext: TeamContext

作業的小組內容

傳回

Promise<TestSession>

意見反應

此頁面對您有幫助嗎？

共用方式為

TestRestClient class

建構函式

屬性

方法

建構函式詳細資料

TestRestClient(IVssRestClientOptions)

參數

屬性詳細資料

RESOURCE_AREA_ID

屬性值

方法詳細資料

addCustomFields(CustomTestFieldDefinition[], string)

參數

傳回

addTestCasesToSuite(string, number, number, string)

參數

傳回

addTestResultsToTestRun(TestCaseResult[], string, number)

參數

傳回

addWorkItemToTestLinks(WorkItemToTestLinks, string)

參數

傳回

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

參數

傳回

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

參數

傳回

createTestRun(RunCreateModel, string)

參數

傳回

createTestRunAttachment(TestAttachmentRequestModel, string, number)

參數

傳回

createTestSession(TestSession, TeamContext)

參數

傳回

createTestSettings(TestSettings, string)

參數

傳回

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

參數

傳回

deleteSharedParameter(string, number)

參數

傳回

deleteSharedStep(string, number)

參數

傳回

deleteTestCase(string, number)

參數

傳回

deleteTestMethodToWorkItemLink(string, string, number)

參數

傳回

deleteTestRun(string, number)

參數

傳回

deleteTestSettings(string, number)

參數

傳回

getBugsLinkedToTestResult(string, number, number)

參數

傳回

getBuildCodeCoverage(string, number, number)

參數

傳回

getCodeCoverageSummary(string, number, number)

參數

傳回

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

參數

傳回

getPoint(string, number, number, number, string)

參數

傳回

getPoints(string, number, number, string, string, string, string, boolean, number, number)

參數