Runs - Get Test Run By Id
ID でテスト実行を取得します。
GET https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId}?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId}?includeDetails={includeDetails}&api-version=7.1-preview.3
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
run
|
path | True |
integer int32 |
取得する実行の ID。 |
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。 |
include
|
query |
boolean |
既定値は true です。 これには、実行統計、リリース、ビルド、テスト環境、プロセス後の状態などの詳細が含まれます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
成功した操作 |
セキュリティ
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 | テスト計画、ケース、結果、その他のテスト管理関連の成果物を読み取る機能を付与します。 |
例
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs/1?api-version=7.1-preview.3
Sample Response
{
"id": 1,
"name": "sprint1 (Manual)",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/1",
"isAutomated": false,
"iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
"owner": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber",
"uniqueName": "fabrikamfiber1@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
},
"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-04T12:50:33.17Z",
"completedDate": "2014-05-04T12:50:31.953Z",
"state": "Completed",
"plan": {
"id": "1",
"name": "sprint1",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
},
"postProcessState": "Complete",
"totalTests": 1,
"passedTests": 1,
"createdDate": "2014-05-04T12:50:31.38Z",
"lastUpdatedDate": "2014-05-04T12:50:31.953Z",
"lastUpdatedBy": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber",
"uniqueName": "fabrikamfiber1@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
},
"revision": 3
}
定義
名前 | 説明 |
---|---|
Build |
BuildConfiguration の詳細。 |
Custom |
ユーザー設定フィールド情報。 許可されるキー: 値のペア - ( AttemptId: int value, IsTestResultFlaky: bool) |
Dtl |
これは、テスト実行環境の詳細を提供する一時的なクラスです。 |
Identity |
|
Job |
パイプライン内のジョブ。 これは、YAML でのマトリックス化に関連しています。 |
Phase |
パイプラインのフェーズ |
Pipeline |
パイプライン リファレンス |
Reference |
REST 参照リンクのコレクションを表す クラス。 |
Release |
リリースへの参照。 |
Result |
指定された結果/カウントの ResultMetadata。 |
Run |
このクラスは、検出に使用されるフィルターを提供するために使用されます |
Run |
結果ごとの実行統計をテストします。 |
Shallow |
他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。 |
Stage |
パイプラインのステージ |
Test |
テスト環境の詳細。 |
Test |
解決状態の詳細をテストします。 |
Test |
テスト実行の詳細。 |
Test |
テスト実行のサブ状態の種類。 |
Test |
実行または結果にアタッチされたタグ。 |
BuildConfiguration
BuildConfiguration の詳細。
名前 | 型 | 説明 |
---|---|---|
branchName |
string |
ビルドが生成されるブランチ名。 |
buildDefinitionId |
integer |
ビルド用の BuildDefinitionId。 |
buildSystem |
string |
ビルド システム。 |
creationDate |
string |
ビルドの作成日。 |
flavor |
string |
ビルド フレーバー (ビルド/リリースなど)。 |
id |
integer |
BuildConfiguration Id。 |
number |
string |
ビルド番号。 |
platform |
string |
BuildConfiguration Platform。 |
project |
この 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 |
このフィールドには、グラフの件名に関する 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 |
ジョブの参照 |
|
phaseReference |
フェーズの参照。 |
|
pipelineId |
integer |
このパイプライン インスタンスが関連付けられているパイプラインの参照。 |
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 |
メタデータを再実行する |
RunFilter
このクラスは、検出に使用されるフィルターを提供するために使用されます
名前 | 型 | 説明 |
---|---|---|
sourceFilter |
string |
テスト ケース ソースのフィルター (テスト コンテナー) |
testCaseFilter |
string |
テスト ケースのフィルター |
RunStatistic
結果ごとの実行統計をテストします。
名前 | 型 | 説明 |
---|---|---|
count |
integer |
指定された結果のテスト結果数。 |
outcome |
string |
結果のテスト結果 |
resolutionState |
テスト実行の解決状態。 |
|
resultMetadata |
指定された結果/カウントの ResultMetadata。 |
|
state |
string |
テスト実行の状態 |
ShallowReference
他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの ID |
name |
string |
リンクされたリソースの名前 (定義名、コントローラー名など) |
url |
string |
リソースへの完全な http リンク |
StageReference
パイプラインのステージ
名前 | 型 | 説明 |
---|---|---|
attempt |
integer |
ステージの試行数 |
stageName |
string |
ステージの名前。 name でサポートされる最大長は 256 文字です。 |
TestEnvironment
テスト環境の詳細。
名前 | 型 | 説明 |
---|---|---|
environmentId |
string |
テスト環境 ID。 |
environmentName |
string |
テスト環境名。 |
TestResolutionState
解決状態の詳細をテストします。
名前 | 型 | 説明 |
---|---|---|
id |
integer |
テスト解決状態 ID。 |
name |
string |
解決状態名をテストします。 |
project |
他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する一様な方法でビルド データ コントラクトを提供するために使用されます。 |
TestRun
テスト実行の詳細。
名前 | 型 | 説明 |
---|---|---|
build |
このテスト実行に関連付けられているビルド。 |
|
buildConfiguration |
このテスト実行に関連付けられているビルド構成の詳細。 |
|
comment |
string |
実行を分析しているユーザーによって入力されたコメント。 |
completedDate |
string |
実行の完了日時。 |
controller |
string |
テスト実行コントローラー。 |
createdDate |
string |
テスト実行 CreatedDate。 |
customFields |
TestRun のユーザー設定フィールドの一覧。 |
|
dropLocation |
string |
テスト実行の [場所] を削除します。 |
dtlAutEnvironment |
他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。 |
|
dtlEnvironment |
他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。 |
|
dtlEnvironmentCreationDetails |
これは、テスト実行環境の詳細を提供する一時的なクラスです。 |
|
dueDate |
string |
テストの実行期限の日付と時刻。 |
errorMessage |
string |
実行に関連付けられているエラー メッセージ。 |
filter |
このクラスは、検出に使用されるフィルターを提供するために使用されます |
|
id |
integer |
テスト実行の ID。 |
incompleteTests |
integer |
不完全なテストの数。 |
isAutomated |
boolean |
テストの実行が自動化されている場合は true、それ以外の場合は false。 |
iteration |
string |
実行が属するイテレーション。 |
lastUpdatedBy |
最後に更新されたテスト実行の Team Foundation ID。 |
|
lastUpdatedDate |
string |
最終更新日時 |
name |
string |
テストの実行の名前。 |
notApplicableTests |
integer |
該当しないテストの数。 |
owner |
実行の所有者の Team Foundation ID。 |
|
passedTests |
integer |
実行で成功したテストの数 |
phase |
string |
testRun のフェーズ/状態。 |
pipelineReference |
このテスト実行が属するパイプラインの参照。 |
|
plan |
このテスト実行に関連付けられているテスト計画。 |
|
postProcessState |
string |
プロセスの状態の後。 |
project |
この実行に関連付けられているプロジェクト。 |
|
release |
テスト実行のリリース リファレンス。 |
|
releaseEnvironmentUri |
string |
TestRun のリリース環境 URI。 |
releaseUri |
string |
TestRun のリリース URI。 |
revision |
integer |
|
runStatistics |
RunSummary by outcome. |
|
startedDate |
string |
実行の開始日時。 |
state |
string |
実行の状態。 Type TestRunState Valid states - Unspecified ,NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation |
substate |
TestRun サブ状態。 |
|
tags |
Test |
このテスト実行に添付されたタグ。 |
testEnvironment |
実行に関連付けられているテスト環境。 |
|
testMessageLogId |
integer |
|
testSettings |
他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。 |
|
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 |
run に timedOut がある場合の実行状態。 |
TestTag
実行または結果にアタッチされたタグ。
名前 | 型 | 説明 |
---|---|---|
name |
string |
タグの名前、30 文字未満の英数字 |