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)	指定した buildId の添付ファイルを LogStore に作成します。
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)	指定した runId の添付ファイルを LogStore に作成します。
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)	指定した runId の指定したファイル名を持つ添付ファイルを LogStore から削除します。
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 Request: ビルド ID とデルタビルド ID (省略可能)
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)	指定した runId の指定したファイル名を持つ添付ファイルを LogStore から返します。
getTestRunLogStoreAttachments(string, number)	指定した runId の添付ファイルの一覧を LogStore から返します。
getTestRunLogStoreAttachmentZip(string, number, string)	指定した runId の指定したファイル名を持つ添付ファイルを LogStore から返します。
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)	テストサブresult 添付ファイルリファレンスの一覧を取得する
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 Request: コードカバレッジの概要の 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

プロジェクト ID またはプロジェクト名

戻り値

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

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

パラメーター

results: TestCaseResult[]

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

テスト実行セッションにテスト結果を追加する

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

パラメーター

results: TestCaseResult[]

project: string

プロジェクト ID またはプロジェクト名

runId: number

テスト実行の RunId

戻り値

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

パラメーター

workItemToTestLinks: WorkItemToTestLinks

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<WorkItemToTestLinks>

createAnalysis(TestSessionAnalysis[], string, number)

特定のセッションの TCM データストアにセッション分析オブジェクトを作成します。

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

パラメーター

analysis: TestSessionAnalysis[]

セッション分析の詳細

project: string

プロジェクト ID またはプロジェクト名

sessionId: number

通知を追加するセッションの ID

戻り値

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

指定した buildId の添付ファイルを LogStore に作成します。

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

パラメーター

attachmentRequestModel: TestAttachmentRequestModel

ストリーム、ファイル名、コメント、attachmentType などの添付ファイル情報が含まれています

project: string

プロジェクト ID またはプロジェクト名

buildId: number

BuildId

戻り値

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

TCM データストアに Environment オブジェクトを作成します

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

パラメーター

environments: TestSessionEnvironment[]

受信した環境オブジェクト。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

指定された sessionId に対して、TCM データストアに環境、構成、およびマシンオブジェクトを作成します

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

パラメーター

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

プロジェクト ID またはプロジェクト名

sessionId: number

戻り値

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

新しいテストエラーの種類を作成します

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

パラメーター

testResultFailureType: TestResultFailureTypeRequestModel

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

特定のセッションの TCM データストアに Notification オブジェクトを作成します

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

パラメーター

notifications: TestSessionNotification[]

指定した sessionId に対して追加する通知

project: string

プロジェクト ID またはプロジェクト名

sessionId: number

通知を追加するセッションの ID

戻り値

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

戻り値

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

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

パラメーター

testRun: RunCreateModel

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

パラメーター

attachmentRequestModel: TestAttachmentRequestModel

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

指定した runId の添付ファイルを LogStore に作成します。

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

パラメーター

attachmentRequestModel: TestAttachmentRequestModel

ストリーム、ファイル名、コメント、attachmentType などの添付ファイル情報が含まれています

project: string

プロジェクト ID またはプロジェクト名

runId: number

Test RunId

戻り値

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

TCM データストアに TestResultsSession オブジェクトを作成します

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

パラメーター

session: TestResultsSession

受信したセッションオブジェクト。

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<number>

createTestSettings(TestSettings, string)

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

パラメーター

testSettings: TestSettings

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<number>

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

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

パラメーター

attachmentRequestModel: TestAttachmentRequestModel

project: string

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

testSubResultId: number

戻り値

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

testExtensionFieldId: number

戻り値

Promise<void>

deleteFailureType(string, number)

指定した failureTypeId を持つテストエラーの種類を削除します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

failureTypeId: number

戻り値

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

testName: string

workItemId: number

戻り値

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

attachmentId: number

戻り値

Promise<void>

deleteTestRun(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<void>

deleteTestRunAttachment(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

attachmentId: number

戻り値

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

指定した runId の指定したファイル名を持つ添付ファイルを LogStore から削除します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

Test RunId

filename: string

Attachment FileName

戻り値

Promise<void>

deleteTestSettings(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

testSettingsId: number

戻り値

Promise<void>

fetchSourceCodeCoverageReport(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

戻り値

Promise<SourceViewBuildCoverage[]>

getBugsLinkedToTestResult(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

戻り値

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

flags: number

戻り値

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: ビルド ID とデルタビルド ID (省略可能)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

definition: string

定義の ID または名前。

branchName: string

ブランチ名。

label: string

バッジの左側にある既定のテキストを置き換える文字列。

戻り値

Promise<string>

getFailureTypes(string)

テストエラーの種類の一覧を返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

指定したファイルのファイルカバレッジを取得する

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

パラメーター

fileCoverageRequest: FileCoverageRequest

pull request イテレーションコンテキストを含むファイルの詳細

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildDefinitionId: number

minBuildCreatedDate: Date

戻り値

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

buildId: number

publishContext: string

fields: string[]

continuationToken: string

戻り値

Promise<PagedList<FieldDetailsForTestResults>>

getResultGroupsByRelease(string, number, string, number, string[], string)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

戻り値

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

TCM データストア内の TestResultsSession 通知オブジェクトを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

sessionId: number

通知を取得する TestResults セッションの ID。

戻り値

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

プロジェクト ID またはプロジェクト名

runId: number

テスト実行の ID

testResultId: number

テスト実行内のテスト結果の ID

testSubResultId: number

テスト結果内のサブ結果の ID

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

buildId: number

取得するビルドの ID

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

プロジェクト ID またはプロジェクト名

build: number

取得するビルドの ID

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

プロジェクト ID またはプロジェクト名

runId: number

結果を含むテスト実行の ID

resultId: number

ファイルをダウンロードする必要があるテスト結果の ID

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

プロジェクト ID またはプロジェクト名

runId: number

ファイルをダウンロードする必要があるテスト実行の ID

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

プロジェクト ID またはプロジェクト名

runId: number

結果を含むテスト実行の ID

resultId: number

サブ結果を含むテスト結果の ID

subResultId: number

ファイル SAS URI が必要なテストサブresult の ID

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

プロジェクト ID またはプロジェクト名

pipelineId: number

パイプライン ID。これはビルド ID と同じです。

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

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

attachmentId: number

戻り値

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

戻り値

Promise<TestResultsDetails>

getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

戻り値

Promise<TestResultsDetails>

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

プロジェクト ID またはプロジェクト名

runId: number

結果を含むテスト実行の ID

resultId: number

テスト結果の ID

type: TestLogType

取得する添付ファイルの種類

directoryPath: string

取得する添付ファイルのディレクトリパス

fileNamePrefix: string

添付ファイルの一覧をフィルター処理するファイル名プレフィックス

fetchMetaData: boolean

既定値は false で、メタデータが必要な場合に設定します

top: number

返される添付ファイル参照の Numbe

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

pipelineId: number

パイプライン ID。これはビルド ID と同じです。

stageName: string

ステージの名前。名前でサポートされる最大長は 256 文字です。

phaseName: string

フェーズの名前。名前でサポートされる最大長は 256 文字です。

jobName: string

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

プロジェクト ID またはプロジェクト名

戻り値

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

settingsType: TestResultsSettingsType

戻り値

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

戻り値

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

テスト実行の添付ファイルを返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

attachmentId: number

戻り値

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

テスト実行の添付ファイルを返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

runId: number

includeDetails: boolean

includeTags: boolean

戻り値

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

runId: number

テスト実行の ID

type: TestLogType

取得する添付ファイルの種類

directoryPath: string

添付ファイルが必要なディレクトリパス

fileNamePrefix: string

添付ファイルの一覧をフィルター処理するファイル名プレフィックス

fetchMetaData: boolean

既定値は false で、メタデータが必要な場合に設定します

top: number

返される添付ファイル参照の数

continuationToken: String

continuationToken を渡すヘッダー

戻り値

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

指定した runId の指定したファイル名を持つ添付ファイルを LogStore から返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

Test RunId

filename: string

Attachment FileName

戻り値

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

指定した runId の添付ファイルの一覧を LogStore から返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

Test RunId

戻り値

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

指定した runId の指定したファイル名を持つ添付ファイルを LogStore から返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

Test RunId

filename: string

Attachment FileName

戻り値

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

テスト実行メッセージログを取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

取得する実行の ID。

戻り値

Promise<TestMessageLogDetails[]>

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildUri: string

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

プロジェクト ID またはプロジェクト名

sessionId: number

テストの実行を取得する TestResults セッションの ID。

戻り値

Promise<number[]>

getTestRunStatistics(string, number)

テスト実行統計を取得します。結果による実行の概要を取得する場合に使用されます。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

取得する実行の ID。

戻り値

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

結果による実行の概要を取得する場合に使用されるテスト実行の概要を取得します。テストの実行は完了状態である必要があります。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

取得する実行の ID。

戻り値

Promise<TestRunStatistic>

getTestSession(string, number)

TCM データストアの TestResultsSession メタデータオブジェクトを取得します

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

戻り値

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

TCM データストアの TestResultsSession Layout オブジェクトを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

sessionId: string

戻り値

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

TCM データストアの TestResultsSession Layout オブジェクトを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

testSettingsId: number

戻り値

Promise<TestSettings>

getTestSubResultAttachmentContent(string, number, number, number, number)

テストサブ結果の添付ファイルを返します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

runId: number

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

戻り値

Promise<ArrayBuffer>

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

テストサブresult 添付ファイルリファレンスの一覧を取得する

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

プロジェクト ID またはプロジェクト名

runId: number

結果を含むテスト実行の ID

resultId: number

サブ結果を含むテスト結果の ID

subResultId: number

テストサブresult の ID

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

プロジェクト ID またはプロジェクト名

buildId: number

ビルド ID

戻り値

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

リリース内のすべてのタグを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

releaseId: number

リリース ID

releaseEnvId: number

リリース環境 ID

戻り値

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

ビルド内のすべてのタグを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

ビルド ID

戻り値

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

リリース内のすべてのタグを取得します。

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

releaseId: number

リリース ID

releaseEnvId: number

リリース環境 ID

戻り値

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

パラメーター

document: TestResultDocument

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

scopeFilter: CustomTestFieldScope

戻り値

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

パラメーター

filter: TestResultTrendFilter

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

パラメーター

filter: TestResultTrendFilter

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

TestHistoryQuery を使用してテストメソッドの履歴を取得する

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

パラメーター

filter: TestHistoryQuery

履歴を取得する TestHistoryQuery

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

testName: string

戻り値

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

パラメーター

filter: ResultsFilter

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

対応する testcasereferenceId のテスト結果メタデータの詳細の一覧を取得する

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

パラメーター

testCaseReferenceIds: string[]

クエリを実行するテスト結果の TestCaseReference ID、有効な ID のコンマ区切りリスト (id の制限番号 200)。

project: string

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

pipelineId: number

パイプライン ID。これはビルド ID と同じです。

stageName: string

ステージの名前。名前でサポートされる最大長は 256 文字です。

phaseName: string

フェーズの名前。名前でサポートされる最大長は 256 文字です。

jobName: string

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

プロジェクト ID またはプロジェクト名

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

戻り値

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

パラメーター

releases: ReleaseReference[]

project: string

プロジェクト ID またはプロジェクト名

戻り値

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

プロジェクト ID またはプロジェクト名

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

プロジェクト ID またはプロジェクト名

minLastUpdatedDate: Date

クエリを実行する最終更新日の最小値 (必須)。

maxLastUpdatedDate: Date

クエリを実行する実行の最終変更日の最大値 (必須、最小日付と最大日付の差は最大 7 日間です)。

state: TestRunState

クエリを実行する実行の現在の状態。

planIds: number[]

クエリを実行する実行のプラン ID、有効な ID のコンマ区切りの一覧。

isAutomated: boolean

クエリを実行する実行のオートメーションの種類。

publishContext: TestRunPublishContext

クエリを実行する実行の PublishContext。

buildIds: number[]

クエリを実行する実行のビルド ID、有効な ID のコンマ区切りの一覧。

buildDefIds: number[]

クエリを実行する実行のビルド定義 ID、有効な ID のコンマ区切りの一覧。

branchName: string

クエリを実行する実行のソースブランチ名。

releaseIds: number[]

クエリを実行する実行のリリース ID、有効な ID のコンマ区切りの一覧。

releaseDefIds: number[]

クエリを実行する実行のリリース定義 ID、有効な ID のコンマ区切りの一覧。

releaseEnvIds: number[]

クエリを実行する実行のリリース環境 ID、有効な ID のコンマ区切りの一覧。

releaseEnvDefIds: number[]

クエリを実行する実行のリリース環境定義 ID、有効な ID のコンマ区切りの一覧。

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

プロジェクト ID またはプロジェクト名

workItemIds: number[]

戻り値

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

ビルドコンテナーの SAS URI を作成して取得する

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

取得するビルドの ID

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

プロジェクト ID またはプロジェクト名

runId: number

結果を含むテスト実行の ID

resultId: number

サブ結果を含むテスト結果の ID

subResultId: number

ファイル SAS URI が必要なテストサブ結果の ID

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

プロジェクト ID またはプロジェクト名

runId: number

エンドポイントの詳細を取得する実行の ID

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

プロジェクト ID またはプロジェクト名

pipelineId: number

パイプライン ID。これはビルド ID と同じです。

stageName: string

ステージの名前。名前でサポートされる最大長は 256 文字です。

phaseName: string

フェーズの名前。名前でサポートされる最大長は 256 文字です。

jobName: string

shouldIncludeFailedAndAbortedResults: boolean

true の場合、各テストグループの失敗した結果と中止された結果の ID が返されます

queryGroupSummaryForInProgress: boolean

true の場合、InProgress の実行の概要も計算されます。

戻り値

Promise<TestResultsDetails>

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: コードカバレッジの概要の Json

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

パラメーター

project: string

プロジェクト ID またはプロジェクト名

buildId: number

coverageData: CodeCoverageData

戻り値

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

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

パラメーター

updateCustomTestField: CustomTestFieldUpdateDefinition

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

テスト結果のプロジェクト設定を更新する

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

パラメーター

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

プロジェクト ID またはプロジェクト名

戻り値

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

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

パラメーター

results: TestCaseResult[]

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

テスト結果メタデータのプロパティを更新する

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

パラメーター

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData 更新入力 TestResultMetaDataUpdateInput

project: string

プロジェクト ID またはプロジェクト名

testCaseReferenceId: number

更新するテスト結果の TestCaseReference ID。

戻り値

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

既存のテスト結果用に TCM データストアに TestResultsMRX オブジェクトを作成します

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

パラメーター

results: TestCaseResult[]

テスト結果 MRX プロパティと既存の testResultId のみを持つ Results オブジェクト

project: string

プロジェクト ID またはプロジェクト名

runId: number

テスト実行の RunId

戻り値

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

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

パラメーター

runUpdateModel: RunUpdateModel

project: string

プロジェクト ID またはプロジェクト名

runId: number

戻り値

Promise<TestRun>

updateTestRunTags(TestTagsUpdateModel, string, number)

実行のタグを更新し、タグを追加および削除できます

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

パラメーター

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

プロジェクト ID またはプロジェクト名

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)

パラメーター