TestRestClient class
VSS REST API への要求を行うために使用する (から派生する) 基本クラス
- Extends
コンストラクター
| Test |
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
TestRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringプロパティ値
string
メソッドの詳細
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>パラメーター
- newFields
- 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
追加するテスト結果の一覧。
- 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
flags の値は、フェッチするコード カバレッジの詳細のレベルを決定します。 フラグは加算です。 想定される値は、モジュールの場合は 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
Delta ビルド 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
configurationId と testCaseId が設定されていない場合にのみ有効な、テスト ポイント ID のコンマ区切りリストのテスト ポイントを取得します。
- 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。
- 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
テスト イテレーションで実行された各アクションの結果の詳細を含めます。 ActionResults は、手動テストの実行中に実行されるテスト ステップの結果 (合格/失敗) を指します。 ActionResults フラグを含めると、actionResults セクションのテスト ステップの結果が取得され、各テスト イテレーションの parameters セクションのテスト パラメーターが取得されます。
戻り値
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
テスト結果に含める詳細。 既定値はなしです。 その他の値は、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
テスト結果に含める詳細。 既定値はなしです。 その他の値は Iterations と WorkItems です。
- skip
-
number
最初からスキップするテスト結果の数。
- top
-
number
返されるテスト結果の数。 detailsToInclude が None の場合は最大 1000、それ以外の場合は 200 です。
- outcomes
テスト結果をフィルター処理するためのテスト結果のコンマ区切りの一覧。
戻り値
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
- 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
- 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
flags の値は、フェッチするコード カバレッジの詳細のレベルを決定します。 フラグは加算です。 想定される値は、モジュールの場合は 1、関数の場合は 2、BlockData の場合は 4 です。
戻り値
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>
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 ID、有効な 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
- 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 のコンマ区切りの一覧 (ids 10 の制限番号)。
- releaseEnvDefIds
-
number[]
クエリを実行する実行のリリース環境定義 ID、有効な ID のコンマ区切りリスト (id の制限番号 10)。
- runTitle
-
string
クエリを実行する実行の実行タイトル。
- top
-
number
クエリを実行する実行の数。 制限は 100 です
- continuationToken
-
string
前のバッチから受信した continuationToken、または最初のバッチの場合は null。 ユーザーが作成 (または最後のバッチから受信した場合は変更) することは想定されていません。
戻り値
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 Request: コード カバレッジの概要の 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
更新するテスト結果の一覧。
- 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>