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)	テスト実行を ID で削除します。
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)	テストケース ID を持つテストスイート内の特定のテストケースを取得します。
getTestCases(string, number, number)	すべてのテストケースをスイートに取得します。
getTestIteration(string, number, number, number, boolean)	結果の反復を取得する
getTestIterations(string, number, number, boolean)	結果の反復を取得する
getTestResultAttachmentContent(string, number, number, number)	テスト結果の添付ファイルを ID でダウンロードします。
getTestResultAttachments(string, number, number)	テスト結果の添付ファイルリファレンスのリストを取得します。
getTestResultAttachmentZip(string, number, number, number)	テスト結果の添付ファイルを ID でダウンロードします。
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 は、特定の自動テスト方法のフィールド/傾向が指定された ID ごとに結果を返します。この API はまだ改善中であり、適切な署名と契約は最終決定されていません。
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)	テスト実行の添付ファイルを ID でダウンロードします。
getTestRunAttachments(string, number)	テスト実行添付ファイルのリファレンスの一覧を取得します。
getTestRunAttachmentZip(string, number, number)	テスト実行の添付ファイルを ID でダウンロードします。
getTestRunById(string, number, boolean)	ID でテストの実行を取得します。
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)	テスト実行を ID で更新します。
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

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

戻り値

Promise<CustomTestFieldDefinition[]>

addTestCasesToSuite(string, number, number, string)

テストケースをスイートに追加します。

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

パラメーター

project: string

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

planId: number

スイートを含むテスト計画の ID。

suiteId: number

テストケースを追加する必要があるテストスイートのID。

testCaseIds: string

スイートに追加するテストケースの ID。 ID はカンマ区切り形式で指定されます。

戻り値

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

テスト結果をテスト実行に追加します。

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

パラメーター

results: TestCaseResult[]

追加するテスト結果のリスト。

project: string

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

runId: number

テスト結果を追加するテスト実行 ID。

戻り値

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

パラメーター

workItemToTestLinks: WorkItemToTestLinks

project: string

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

戻り値

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

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

runId: number

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

testCaseResultId: number

反復を含むテスト結果の ID

iterationId: number

テスト結果の反復の ID。

actionPath: string

テスト結果アクションパスの16進数値。

戻り値

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

テスト結果にファイルを添付します。

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

パラメーター

attachmentRequestModel: TestAttachmentRequestModel

添付ファイルの詳細 TestAttachmentRequestModel

project: string

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

runId: number

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

testCaseResultId: number

添付ファイルをアップロードする必要があるテスト結果の ID。

戻り値

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

新しいテスト実行を作成します。

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

パラメーター

testRun: RunCreateModel

実行の詳細 RunCreateModel

project: string

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

戻り値

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

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

パラメーター

attachmentRequestModel: TestAttachmentRequestModel

添付ファイルの詳細 TestAttachmentRequestModel

project: string

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

runId: number

添付ファイルをアップロードする必要があるテスト実行の ID。

戻り値

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

プロジェクト 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

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

testCaseResultId: number

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

testSubResultId: number

添付ファイルをアップロードする必要があるテストサブ結果の ID。

戻り値

Promise<TestAttachmentReference>

deleteSharedParameter(string, number)

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

パラメーター

project: string

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

sharedParameterId: number

戻り値

Promise<void>

deleteSharedStep(string, number)

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

パラメーター

project: string

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

sharedStepId: number

戻り値

Promise<void>

deleteTestCase(string, number)

テストケースを削除します。

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

パラメーター

project: string

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

testCaseId: number

削除するテストケースの ID。

戻り値

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>

deleteTestRun(string, number)

テスト実行を ID で削除します。

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

パラメーター

project: string

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

runId: number

削除する実行の ID。

戻り値

Promise<void>

deleteTestSettings(string, number)

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

パラメーター

project: string

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

testSettingsId: number

戻り値

Promise<void>

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

コードカバレッジデータをフェッチする必要があるビルドの ID。

flags: number

フラグの値は、フェッチするコード・カバレッジの詳細のレベルを決定します。フラグは加算です。期待値は、モジュールの場合は 1、関数の場合は 2、BlockData の場合は 4 です。

戻り値

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

ビルドのコードカバレッジの概要を取得します。

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

パラメーター

project: string

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

buildId: number

コードカバレッジデータをフェッチする必要があるビルドの ID。

deltaBuildId: number

デルタビルド ID (省略可能)

戻り値

Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

パラメーター

workItemQuery: LinkedWorkItemsQuery

project: string

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

戻り値

Promise<LinkedWorkItemsQueryResult[]>

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

テストポイントを取得します。

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

パラメーター

project: string

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

planId: number

テスト計画の ID。

suiteId: number

ポイントを含むスイートの ID。

pointIds: number

取得するテストポイントの ID。

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

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

planId: number

テスト計画の ID。

suiteId: number

ポイントを含むスイートの ID。

witFields: string

作業項目フィールド名のコンマ区切りリスト。

configurationId: string

特定の構成のテストポイントを取得します。

testCaseId: string

特定のテストケースのテストポイントを取得し、configurationId が設定されていない場合に有効です。

testPointIds: string

テストポイントIDのコンマ区切りリストのテストポイントを取得し、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

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

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

プロジェクト 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>>

getResultRetentionSettings(string)

テスト結果の保持設定を取得する

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

パラメーター

project: string

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

戻り値

Promise<ResultRetentionSettings>

getTestCaseById(string, number, number, number)

テストケース ID を持つテストスイート内の特定のテストケースを取得します。

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

パラメーター

project: string

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

planId: number

スイートを含むテスト計画の ID。

suiteId: number

テスト・ケースを含むスイートの ID。

testCaseIds: number

取得するテストケースの ID。

戻り値

Promise<SuiteTestCase>

getTestCases(string, number, number)

すべてのテストケースをスイートに取得します。

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

パラメーター

project: string

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

planId: number

スイートを含むテスト計画の ID。

suiteId: number

取得するスイートの ID。

戻り値

Promise<SuiteTestCase[]>

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

結果の反復を取得する

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

パラメーター

project: string

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

runId: number

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

testCaseResultId: number

反復を含むテスト結果の ID。

iterationId: number

テスト結果の Id Iteration。

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

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

runId: number

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

testCaseResultId: number

反復を含むテスト結果の ID。

includeActionResults: boolean

戻り値

Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent(string, number, number, number)

テスト結果の添付ファイルを ID でダウンロードします。

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

パラメーター

project: string

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

runId: number

testCaseResultId を含むテスト実行の ID。

testCaseResultId: number

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

attachmentId: number

ダウンロードするテスト結果の添付ファイルの ID。

戻り値

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

テスト結果の添付ファイルリファレンスのリストを取得します。

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

パラメーター

project: string

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

runId: number

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

testCaseResultId: number

テスト結果の ID。

戻り値

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

テスト結果の添付ファイルを ID でダウンロードします。

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

パラメーター

project: string

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

runId: number

testCaseResultId を含むテスト実行の ID。

testCaseResultId: number

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

attachmentId: number

ダウンロードするテスト結果の添付ファイルの ID。

戻り値

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

テスト実行のテスト結果を取得します。

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

パラメーター

project: string

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

runId: number

フェッチするテスト結果のテスト実行 ID。

testCaseResultId: number

テスト結果 ID。

detailsToInclude: ResultDetails

テスト結果に含める詳細。デフォルトは None です。その他の値は、Iterations、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

プロジェクト 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>

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

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

runId: number

フェッチするテスト結果のテスト実行 ID。

detailsToInclude: ResultDetails

テスト結果に含める詳細。デフォルトは None です。その他の値は、Iterations と WorkItems です。

skip: number

最初からスキップするテスト結果の数。

top: number

返されるテスト結果の数。 detailsToInclude が None の場合は最大値は 1000 で、それ以外の場合は 200 です。

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

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

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

戻り値

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

この API は、特定の自動テスト方法のフィールド/傾向が指定された ID ごとに結果を返します。この API はまだ改善中であり、適切な署名と契約は最終決定されていません。

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

パラメーター

query: TestResultsQuery

project: string

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

戻り値

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

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

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

戻り値

Promise<PagedList<ShallowTestCaseResult>>

getTestRunAttachmentContent(string, number, number)

テスト実行の添付ファイルを ID でダウンロードします。

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

パラメーター

project: string

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

runId: number

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

attachmentId: number

ダウンロードするテスト実行添付ファイルの ID。

戻り値

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

テスト実行添付ファイルのリファレンスの一覧を取得します。

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

パラメーター

project: string

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

runId: number

テスト実行の ID。

戻り値

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

テスト実行の添付ファイルを ID でダウンロードします。

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

パラメーター

project: string

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

runId: number

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

attachmentId: number

ダウンロードするテスト実行添付ファイルの ID。

戻り値

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

ID でテストの実行を取得します。

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

パラメーター

project: string

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

runId: number

取得する実行の ID。

includeDetails: boolean

既定値は true です。これには、実行統計、リリース、ビルド、テスト環境、後処理の状態などの詳細が含まれます。

戻り値

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

テスト実行のコードカバレッジデータを取得する

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

パラメーター

project: string

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

runId: number

コード・カバレッジ・データをフェッチする必要があるテスト実行の ID。

flags: number

戻り値

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

テスト実行メッセージログの取得

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

実行が使用したビルドの URI。

owner: string

実行の所有者のチーム基盤 ID。

tmiRunId: string

planId: number

実行が属するテスト計画の ID。

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

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

runId: number

取得する実行の ID。

戻り値

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

プロジェクト 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

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

testCaseResultId: number

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

attachmentId: number

ダウンロードするテスト結果の添付ファイルのID

testSubResultId: number

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

戻り値

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

テストサブ結果の添付ファイルのリストを取得する

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

パラメーター

project: string

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

runId: number

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

testCaseResultId: number

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

testSubResultId: number

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

戻り値

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

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

testCaseResultId: number

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

attachmentId: number

ダウンロードするテスト結果の添付ファイルのID

testSubResultId: number

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

戻り値

Promise<ArrayBuffer>

processSuitesForStaging(StagedSuitesRequestModel, string, number)

テストスイートのコレクションを処理し、スイートとテストケースの詳細を含む応答モデルを返します。

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

パラメーター

request: StagedSuitesRequestModel

処理するテストスイートを含む要求モデル。 null にすることはできません。

project: string

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

workItemId: number

戻り値

Promise<StagedSuitesResponseModel>

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)

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

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

パラメーター

testReferenceIds: string[]

照会されるテスト結果のTestCaseReference Ids、有効なIDのコンマ区切りリスト(IDの制限番号200)。

project: string

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

戻り値

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>

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)

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

パラメーター

project: string

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

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

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

minLastUpdatedDate: Date

照会する実行の最小最終更新日 (必須)。

maxLastUpdatedDate: Date

クエリされる実行の最大最終更新日(必須、最小日付と最大日付の差は最大7日です)。

state: TestRunState

照会する実行の現在の状態。

planIds: number[]

照会される実行のプラン ID、有効な ID のコンマ区切りリスト (ID 10 の制限数)。

isAutomated: boolean

クエリする実行の自動化タイプ。

publishContext: TestRunPublishContext

PublishContext を呼び出します。

buildIds: number[]

クエリされる実行のビルド ID、有効な ID のコンマ区切りリスト (ID の制限数 10)。

buildDefIds: number[]

クエリされる実行のビルド定義 ID、有効な ID のコンマ区切りリスト (ID の制限番号 10)。

branchName: string

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

releaseIds: number[]

クエリされる実行のリリースID、有効なIDのコンマ区切りリスト(IDの制限番号10)。

releaseDefIds: number[]

クエリされる実行のリリース定義 ID、有効な ID のコンマ区切りリスト (ID の制限番号 10)。

releaseEnvIds: number[]

クエリされる実行の環境 ID を、有効な ID のコンマ区切りリスト (ID 10 の制限数) をリリースします。

releaseEnvDefIds: number[]

クエリされる実行の環境定義 ID を、有効な ID のコンマ区切りリスト (ID 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

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

workItemIds: number[]

戻り値

Promise<TestSummaryForWorkItem[]>

removeTestCasesFromSuiteUrl(string, number, number, string)

テスト・ケースに関連付けられたテスト・ポイントがテスト・スイートから削除されます。テスト・ケース・ワークアイテムはシステムから削除されません。テストケースを完全に削除するには、テストケースリソースを参照してください。

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

パラメーター

project: string

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

planId: number

スイートを含むテスト計画の ID。

suiteId: number

取得するスイートの ID。

testCaseIds: string

スイートから削除するテストケースの ID。

戻り値

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

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

buildId: number

戻り値

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

テスト結果の保持設定を更新する

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

パラメーター

retentionSettings: ResultRetentionSettings

更新するテスト結果保持設定の詳細

project: string

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

戻り値

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

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

planId: number

スイートを含むテスト計画の ID。

suiteId: number

テストケースを追加する必要があるテストスイートのID。

testCaseIds: string

スイートに追加するテストケースの ID。 ID はカンマ区切り形式で指定されます。

戻り値

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

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

planId: number

テスト計画の ID。

suiteId: number

ポイントを含むスイートの ID。

pointIds: string

取得するテストポイントの ID。複数のテストポイントを更新するには、コンマ区切りの ID リストを使用します。

戻り値

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

テスト実行でテスト結果を更新します。

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

パラメーター

results: TestCaseResult[]

更新するテスト結果のリスト。

project: string

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

runId: number

テスト結果を更新するテスト実行 ID。

戻り値

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

テスト実行を ID で更新します。

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

パラメーター

runUpdateModel: RunUpdateModel

実行の詳細 RunUpdateModel

project: string

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

runId: number

更新する実行の ID。

戻り値

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)

パラメーター