Runs - Create

リファレンス

Service:: Test

API Version:: 7.1-preview.3

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

POST https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=7.1-preview.3

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。

要求本文

名前	型	説明
automated	boolean	テストの実行が自動化されている場合は true、それ以外の場合は false。既定では false になります。
build	ShallowReference	それが属するビルドへの抽象化された参照。
buildDropLocation	string	テストの実行に使用されるビルドの場所を削除します。
buildFlavor	string	テスト実行に使用されるビルドのフレーバー。 (例: リリース、デバッグ)
buildPlatform	string	テスト実行に使用されるビルドのプラットフォーム。 (例: x86、amd64)
buildReference	BuildConfiguration	テスト実行の BuildReference。
comment	string	実行を分析しているユーザーによって入力されたコメント。
completeDate	string	実行の完了日時。
configurationIds	integer[]	実行に関連付けられているテスト構成の ID。
controller	string	自動実行に使用されるテストコントローラーの名前。
customTestFields	CustomTestField[]	テスト実行の追加プロパティ。
dtlAutEnvironment	ShallowReference	DtlAutEnvironment への抽象化された参照。
dtlTestEnvironment	ShallowReference	DtlTestEnvironment への抽象参照。
dueDate	string	テストの実行期限の日付と時刻。
environmentDetails	DtlEnvironmentDetails	これは、テスト実行環境の詳細を提供する一時的なクラスです。
errorMessage	string	実行に関連付けられているエラーメッセージ。
filter	RunFilter	実行の検出に使用されるフィルター。
iteration	string	実行を作成するイテレーション。チームプロジェクトのルートイテレーションが既定になります
name	string	テストの実行の名前。
owner	IdentityRef	実行の所有者の表示名。
pipelineReference	PipelineReference	このテスト実行が属するパイプラインの参照。 PipelineReference.PipelineId は、RunCreateModel.Build.Id と等しい必要があります
plan	ShallowReference	それが属するプランへの抽象化された参照。
pointIds	integer[]	実行で使用するテストポイントの ID。
releaseEnvironmentUri	string	実行に関連付けられているリリース環境の URI。
releaseReference	ReleaseReference	テスト実行に関連付けられているリリースへの参照。
releaseUri	string	実行に関連付けられているリリースの URI。
runSummary	RunSummaryModel[]	実行の種類 = NoConfigRun の実行の概要。
runTimeout	string	実行がタイムアウトするまでの期間。
sourceWorkflow	string	テスト実行の SourceWorkFlow(CI/CD)。
startDate	string	実行の開始日時。
state	string	実行の状態。 Type TestRunState Valid states - NotStarted, InProgress, Waiting
tags	TestTag[]	テスト実行でアタッチするタグ。最大 5 つのタグを追加して実行できます。
testConfigurationsMapping	string	テスト実行の TestConfigurationMapping。
testEnvironmentId	string	実行に関連付けられているテスト環境の ID。
testSettings	ShallowReference	テスト設定リソースへの抽象化された参照。
type	string	run(RunType) の有効な値の種類: (Unspecified、Normal、Blocking、Web、MtrRunInitiatedFromWeb、RunWithDtlEnv、NoConfigRun)

応答

名前	型	説明
200 OK	TestRun	正常な操作

セキュリティ

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名前	説明
vso.test_write	テスト計画、ケース、結果、その他のテスト管理関連の成果物を読み取り、作成、更新する機能を付与します。

例

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs?api-version=7.1-preview.3

{
  "name": "NewTestRun",
  "plan": {
    "id": "1"
  },
  "pointIds": [
    1,
    1
  ]
}

Sample Response

Status code:: 200

{
  "id": 31,
  "name": "NewTestRun",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/31",
  "isAutomated": false,
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
  "owner": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "startedDate": "2014-05-28T16:39:00.44Z",
  "state": "InProgress",
  "plan": {
    "id": "1",
    "name": "sprint1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "postProcessState": "Complete",
  "totalTests": 2,
  "incompleteTests": 2,
  "createdDate": "2014-05-28T16:39:00.4Z",
  "lastUpdatedDate": "2014-05-28T16:39:00.44Z",
  "lastUpdatedBy": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "revision": 2
}

定義

名前	説明
BuildConfiguration	BuildConfiguration の詳細。
CustomTestField	ユーザー設定フィールド情報。許可されるキー: 値のペア - ( AttemptId: int value, IsTestResultFlaky: bool)
DtlEnvironmentDetails	これは、テスト実行環境の詳細を提供する一時的なクラスです。
IdentityRef
JobReference	パイプライン内のジョブ。これは、YAML でのマトリックス化に関連しています。
PhaseReference	パイプラインのフェーズ
PipelineReference	パイプラインリファレンス
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ReleaseReference	リリースへの参照。
ResultMetadata	指定された結果/カウントの ResultMetadata。
RunCreateModel	テスト実行の作成の詳細。
RunFilter	このクラスは、検出に使用されるフィルターを提供するために使用されます
RunStatistic	結果ごとのテスト実行統計。
RunSummaryModel	テストの出力の種類ごとに実行の概要。
ShallowReference	他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。
StageReference	パイプラインのステージ
TestEnvironment	テスト環境の詳細。
TestOutcome
TestResolutionState	解決状態の詳細をテストします。
TestRun	テスト実行の詳細。
TestRunSubstate	テスト実行のサブ状態の種類。
TestTag	実行または結果にアタッチされたタグ。

BuildConfiguration

BuildConfiguration の詳細。

名前	型	説明
branchName	string	ビルドが生成されるブランチ名。
buildDefinitionId	integer	ビルド用の BuildDefinitionId。
buildSystem	string	ビルドシステム。
creationDate	string	ビルドの作成日。
flavor	string	ビルドフレーバー (ビルド/リリースなど)。
id	integer	BuildConfiguration Id。
number	string	ビルド番号。
platform	string	BuildConfiguration Platform。
project	ShallowReference	この BuildConfiguration に関連付けられているプロジェクト。
repositoryGuid	string	ビルドのリポジトリ Guid。
repositoryType	string	リポジトリの種類 (例:TFSGit)。
sourceVersion	string	ビルドのソースバージョン (/最初のコミット) がトリガーされました。
targetBranchName	string	Target BranchName。
uri	string	ビルド URI。

CustomTestField

ユーザー設定フィールド情報。許可されるキー: 値のペア - ( AttemptId: int value, IsTestResultFlaky: bool)

名前	型	説明
fieldName	string	フィールド名。
value	object	フィールド値。

DtlEnvironmentDetails

これは、テスト実行環境の詳細を提供する一時的なクラスです。

名前	型	説明
csmContent	string
csmParameters	string
subscriptionName	string

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用します
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

JobReference

パイプライン内のジョブ。これは、YAML でのマトリックス化に関連しています。

名前	型	説明
attempt	integer	ジョブの試行番号
jobName	string	YAML でのマトリックス化では、マトリックス内の入力が異なるジョブのコピーが生成されます。 JobName は、これらの入力の名前です。 name でサポートされる最大長は 256 文字です。

PhaseReference

パイプラインのフェーズ

名前	型	説明
attempt	integer	フェーズの試行番号
phaseName	string	フェーズの名前。 name でサポートされる最大長は 256 文字です。

PipelineReference

パイプラインリファレンス

名前	型	説明
jobReference	JobReference	ジョブの参照
phaseReference	PhaseReference	フェーズの参照。
pipelineId	integer	このパイプラインインスタンスが関連付けられているパイプラインの参照。
stageReference	StageReference	ステージの参照。

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

ReleaseReference

リリースへの参照。

名前	型	説明
attempt	integer	リリース試行回数。
creationDate	string	リリースの作成日 (UTC)。
definitionId	integer	リリース定義 ID。
environmentCreationDate	string	環境の作成日 (UTC)。
environmentDefinitionId	integer	リリース環境定義 ID。
environmentDefinitionName	string	リリース環境定義名。
environmentId	integer	リリース環境 ID。
environmentName	string	リリース環境名。
id	integer	リリース ID。
name	string	リリース名。

ResultMetadata

指定された結果/カウントの ResultMetadata。

名前	型	説明
flaky	string	不安定なメタデータ
rerun	string	メタデータの再実行

RunCreateModel

テスト実行の作成の詳細。

名前	型	説明
automated	boolean	テストの実行が自動化されている場合は true、それ以外の場合は false。既定では false になります。
build	ShallowReference	それが属するビルドへの抽象化された参照。
buildDropLocation	string	テストの実行に使用されるビルドの場所を削除します。
buildFlavor	string	テスト実行に使用されるビルドのフレーバー。 (例: リリース、デバッグ)
buildPlatform	string	テスト実行に使用されるビルドのプラットフォーム。 (例: x86、amd64)
buildReference	BuildConfiguration	テスト実行の BuildReference。
comment	string	実行を分析しているユーザーによって入力されたコメント。
completeDate	string	実行の完了日時。
configurationIds	integer[]	実行に関連付けられているテスト構成の ID。
controller	string	自動実行に使用されるテストコントローラーの名前。
customTestFields	CustomTestField[]	テスト実行の追加プロパティ。
dtlAutEnvironment	ShallowReference	DtlAutEnvironment への抽象化された参照。
dtlTestEnvironment	ShallowReference	DtlTestEnvironment への抽象参照。
dueDate	string	テストの実行期限の日付と時刻。
environmentDetails	DtlEnvironmentDetails	これは、テスト実行環境の詳細を提供する一時的なクラスです。
errorMessage	string	実行に関連付けられているエラーメッセージ。
filter	RunFilter	実行の検出に使用されるフィルター。
iteration	string	実行を作成するイテレーション。チームプロジェクトのルートイテレーションが既定になります
name	string	テストの実行の名前。
owner	IdentityRef	実行の所有者の表示名。
pipelineReference	PipelineReference	このテスト実行が属するパイプラインの参照。 PipelineReference.PipelineId は、RunCreateModel.Build.Id と等しい必要があります
plan	ShallowReference	それが属するプランへの抽象化された参照。
pointIds	integer[]	実行で使用するテストポイントの ID。
releaseEnvironmentUri	string	実行に関連付けられているリリース環境の URI。
releaseReference	ReleaseReference	テスト実行に関連付けられているリリースへの参照。
releaseUri	string	実行に関連付けられているリリースの URI。
runSummary	RunSummaryModel[]	実行の種類 = NoConfigRun の実行の概要。
runTimeout	string	実行がタイムアウトするまでの期間。
sourceWorkflow	string	テスト実行の SourceWorkFlow(CI/CD)。
startDate	string	実行の開始日時。
state	string	実行の状態。 Type TestRunState Valid states - NotStarted, InProgress, Waiting
tags	TestTag[]	テスト実行でアタッチするタグ。最大 5 つのタグを追加して実行できます。
testConfigurationsMapping	string	テスト実行の TestConfigurationMapping。
testEnvironmentId	string	実行に関連付けられているテスト環境の ID。
testSettings	ShallowReference	テスト設定リソースへの抽象化された参照。
type	string	run(RunType) の有効な値の種類: (Unspecified、Normal、Blocking、Web、MtrRunInitiatedFromWeb、RunWithDtlEnv、NoConfigRun)

RunFilter

このクラスは、検出に使用されるフィルターを提供するために使用されます

名前	型	説明
sourceFilter	string	テストケースソースのフィルター (テストコンテナー)
testCaseFilter	string	テストケースのフィルター

RunStatistic

結果ごとのテスト実行統計。

名前	型	説明
count	integer	指定された結果の結果カウントをテストします。
outcome	string	テスト結果の結果
resolutionState	TestResolutionState	テスト実行の解決状態。
resultMetadata	ResultMetadata	指定された結果/カウントの ResultMetadata。
state	string	テスト実行の状態

RunSummaryModel

テストの出力の種類ごとに実行の概要。

名前	型	説明
duration	integer	合計所要時間 (ミリ秒単位)。
resultCount	integer	結果 TestOutcome の結果の数
testOutcome	TestOutcome	概要は結果に基づいています

ShallowReference

他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。

名前	型	説明
id	string	リソースの ID
name	string	リンクされたリソースの名前 (定義名、コントローラー名など)
url	string	リソースへの完全な http リンク

StageReference

パイプラインのステージ

名前	型	説明
attempt	integer	ステージの試行数
stageName	string	ステージの名前。 name でサポートされる最大長は 256 文字です。

TestEnvironment

テスト環境の詳細。

名前	型	説明
environmentId	string	テスト環境 ID。
environmentName	string	テスト環境名。

TestOutcome

名前	型	説明
aborted	string	テストが中止されました。これは、ユーザージェスチャではなく、フレームワークの決定によって引き起こされました。
blocked	string	ITestElement.IsRunnable == false であるため、テストが実行される可能性はありましたが、実行されませんでした。
error	string	テストの実行中にシステムエラーが発生しました。
failed	string	テストは実行されましたが、問題が発生しました。問題には、例外や失敗したアサーションが含まれる場合があります。
inProgress	string	テストは現在実行中です。 TCM グラフにこれを追加しました
inconclusive	string	テストは完了しましたが、成功したか失敗したかは言えません。中止されたテストに使用できます...
none	string	テストが完了していないか、テストの種類で合格/失敗が報告されません。
notApplicable	string	テストは実行には適用されません。
notExecuted	string	テストが実行されませんでした。これは、ユーザージェスチャ (ユーザーのヒット停止ボタンなど) が原因で発生しました。
notImpacted	string	テストは影響を受けません。 fot TIA を追加しました。
passed	string	問題が発生した場合にテストが実行されました。
paused	string	テストが一時停止しています。
timeout	string	テストがタイムアウトしました
unspecified	string	既存の値を保持するために更新中にのみ使用されます。
warning	string	実行レベルの結果で使用されます。これは失敗ではありません。

TestResolutionState

解決状態の詳細をテストします。

名前	型	説明
id	integer	テスト解決状態 ID。
name	string	テスト解決状態名。
project	ShallowReference	他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。

TestRun

テスト実行の詳細。

名前	型	説明
build	ShallowReference	このテスト実行に関連付けられているビルド。
buildConfiguration	BuildConfiguration	このテスト実行に関連付けられているビルド構成の詳細。
comment	string	実行を分析しているユーザーによって入力されたコメント。
completedDate	string	実行の完了日時。
controller	string	テスト実行コントローラー。
createdDate	string	テスト実行 CreatedDate。
customFields	CustomTestField[]	TestRun のユーザー設定フィールドの一覧。
dropLocation	string	テスト実行の [場所] を削除します。
dtlAutEnvironment	ShallowReference	他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。
dtlEnvironment	ShallowReference	他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。
dtlEnvironmentCreationDetails	DtlEnvironmentDetails	これは、テスト実行環境の詳細を提供する一時的なクラスです。
dueDate	string	テストの実行期限の日付と時刻。
errorMessage	string	実行に関連付けられているエラーメッセージ。
filter	RunFilter	このクラスは、検出に使用されるフィルターを提供するために使用されます
id	integer	テスト実行の ID。
incompleteTests	integer	不完全なテストの数。
isAutomated	boolean	テストの実行が自動化されている場合は true、それ以外の場合は false。
iteration	string	実行が属するイテレーション。
lastUpdatedBy	IdentityRef	最後に更新されたテスト実行の Team Foundation ID。
lastUpdatedDate	string	最終更新日時
name	string	テストの実行の名前。
notApplicableTests	integer	該当しないテストの数。
owner	IdentityRef	実行の所有者の Team Foundation ID。
passedTests	integer	実行で成功したテストの数
phase	string	testRun のフェーズ/状態。
pipelineReference	PipelineReference	このテスト実行が属するパイプラインの参照。
plan	ShallowReference	このテスト実行に関連付けられているテスト計画。
postProcessState	string	プロセスの状態の後。
project	ShallowReference	この実行に関連付けられているプロジェクト。
release	ReleaseReference	テスト実行のリリースリファレンス。
releaseEnvironmentUri	string	TestRun のリリース環境 URI。
releaseUri	string	TestRun のリリース URI。
revision	integer
runStatistics	RunStatistic[]	RunSummary by outcome.
startedDate	string	実行の開始日時。
state	string	実行の状態。 Type TestRunState Valid states - Unspecified ,NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation
substate	TestRunSubstate	TestRun サブ状態。
tags	TestTag[]	このテスト実行に添付されたタグ。
testEnvironment	TestEnvironment	実行に関連付けられているテスト環境。
testMessageLogId	integer
testSettings	ShallowReference	他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。
totalTests	integer	実行中のテストの合計数
unanalyzedTests	integer	実行で失敗したテストの数。
url	string	テスト実行の URL
webAccessUrl	string	TestRun の Web アクセス URL。

TestRunSubstate

テスト実行のサブ状態の種類。

名前	型	説明
abortedBySystem	string	システムによって中止されたときに状態を実行します。
analyzed	string	分析後の実行状態。
canceledByUser	string	環境の作成中に状態を実行します。
cancellationInProgress	string	取り消しが進行中の場合の実行状態。
creatingEnvironment	string	環境の作成中に状態を実行します。
none	string	noState を指定して実行します。
pendingAnalysis	string	保留中の分析中に状態を実行します。
runningTests	string	テストの実行中に状態を実行します。
timedOut	string	実行に timedOut がある場合の実行状態。

TestTag

実行または結果にアタッチされたタグ。

名前	型	説明
name	string	タグの名前、30 文字未満の英数字の値

次の方法で共有