Runs - List
GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs?api-version=7.2-preview.1
GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/runs?buildUri={buildUri}&owner={owner}&tmiRunId={tmiRunId}&planId={planId}&includeRunDetails={includeRunDetails}&automated={automated}&$skip={$skip}&$top={$top}&api-version=7.2-preview.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api. |
$skip
|
query |
integer int32 |
||
$top
|
query |
integer int32 |
||
automated
|
query |
boolean |
||
build
|
query |
string |
||
include
|
query |
boolean |
||
owner
|
query |
string |
||
plan
|
query |
integer int32 |
||
tmi
|
query |
string |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Test |
successful operation |
Security
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
Name | Description |
---|---|
vso.test | Grants the ability to read test plans, cases, results and other test management related artifacts. |
Definitions
Name | Description |
---|---|
Build |
BuildConfiguration Details. |
Custom |
A custom field information. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool) |
Dtl |
This is a temporary class to provide the details for the test run environment. |
Identity |
|
Job |
Job in pipeline. This is related to matrixing in YAML. |
Phase |
Phase in pipeline |
Pipeline |
Pipeline reference |
Reference |
|
Release |
Reference to a release. |
Result |
ResultMetadata for the given outcome/count. |
Run |
This class is used to provide the filters used for discovery |
Run |
Test run statistics per outcome. |
Shallow |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
Stage |
Stage in pipeline |
Test |
Test environment Detail. |
Test |
Test Resolution State Details. |
Test |
Test run details. |
Test |
The types of sub states for test run. |
Test |
Tag attached to a run or result. |
BuildConfiguration
BuildConfiguration Details.
Name | Type | Description |
---|---|---|
branchName |
string |
Branch name for which build is generated. |
buildDefinitionId |
integer |
BuildDefinitionId for build. |
buildSystem |
string |
Build system. |
creationDate |
string |
Build Creation Date. |
flavor |
string |
Build flavor (eg Build/Release). |
id |
integer |
BuildConfiguration Id. |
number |
string |
Build Number. |
platform |
string |
BuildConfiguration Platform. |
project |
Project associated with this BuildConfiguration. |
|
repositoryGuid |
string |
Repository Guid for the Build. |
repositoryType |
string |
Repository Type (eg. TFSGit). |
sourceVersion |
string |
Source Version(/first commit) for the build was triggered. |
targetBranchName |
string |
Target BranchName. |
uri |
string |
Build Uri. |
CustomTestField
A custom field information. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool)
Name | Type | Description |
---|---|---|
fieldName |
string |
Field Name. |
value |
object |
Field value. |
DtlEnvironmentDetails
This is a temporary class to provide the details for the test run environment.
Name | Type | Description |
---|---|---|
csmContent |
string |
|
csmParameters |
string |
|
subscriptionName |
string |
IdentityRef
Name | Type | Description |
---|---|---|
_links | ||
descriptor |
string |
|
directoryAlias |
string |
|
displayName |
string |
|
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
JobReference
Job in pipeline. This is related to matrixing in YAML.
Name | Type | Description |
---|---|---|
attempt |
integer |
Attempt number of the job |
jobName |
string |
Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character. |
PhaseReference
Phase in pipeline
Name | Type | Description |
---|---|---|
attempt |
integer |
Attempt number of the phase |
phaseName |
string |
Name of the phase. Maximum supported length for name is 256 character. |
PipelineReference
Pipeline reference
Name | Type | Description |
---|---|---|
jobReference |
Reference of the job |
|
phaseReference |
Reference of the phase. |
|
pipelineDefinitionId |
integer |
Reference of the BuildDefinitionId. |
pipelineId |
integer |
Reference of the pipeline with which this pipeline instance is related. |
stageReference |
Reference of the stage. |
ReferenceLinks
Name | Type | Description |
---|---|---|
links |
object |
ReleaseReference
Reference to a release.
Name | Type | Description |
---|---|---|
attempt |
integer |
Number of Release Attempt. |
creationDate |
string |
Release Creation Date(UTC). |
definitionId |
integer |
Release definition ID. |
environmentCreationDate |
string |
Environment creation Date(UTC). |
environmentDefinitionId |
integer |
Release environment definition ID. |
environmentDefinitionName |
string |
Release environment definition name. |
environmentId |
integer |
Release environment ID. |
environmentName |
string |
Release environment name. |
id |
integer |
Release ID. |
name |
string |
Release name. |
ResultMetadata
ResultMetadata for the given outcome/count.
Name | Type | Description |
---|---|---|
flaky |
string |
Flaky metadata |
rerun |
string |
Rerun metadata |
RunFilter
This class is used to provide the filters used for discovery
Name | Type | Description |
---|---|---|
sourceFilter |
string |
filter for the test case sources (test containers) |
testCaseFilter |
string |
filter for the test cases |
RunStatistic
Test run statistics per outcome.
Name | Type | Description |
---|---|---|
count |
integer |
Test result count fo the given outcome. |
outcome |
string |
Test result outcome |
resolutionState |
Test run Resolution State. |
|
resultMetadata |
ResultMetadata for the given outcome/count. |
|
state |
string |
State of the test run |
ShallowReference
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.
Name | Type | Description |
---|---|---|
id |
string |
ID of the resource |
name |
string |
Name of the linked resource (definition name, controller name, etc.) |
url |
string |
Full http link to the resource |
StageReference
Stage in pipeline
Name | Type | Description |
---|---|---|
attempt |
integer |
Attempt number of stage |
stageName |
string |
Name of the stage. Maximum supported length for name is 256 character. |
TestEnvironment
Test environment Detail.
Name | Type | Description |
---|---|---|
environmentId |
string |
Test Environment Id. |
environmentName |
string |
Test Environment Name. |
TestResolutionState
Test Resolution State Details.
Name | Type | Description |
---|---|---|
id |
integer |
Test Resolution state Id. |
name |
string |
Test Resolution State Name. |
project |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
TestRun
Test run details.
Name | Type | Description |
---|---|---|
build |
Build associated with this test run. |
|
buildConfiguration |
Build configuration details associated with this test run. |
|
comment |
string |
Comments entered by those analyzing the run. |
completedDate |
string |
Completed date time of the run. |
controller |
string |
Test Run Controller. |
createdDate |
string |
Test Run CreatedDate. |
customFields |
List of Custom Fields for TestRun. |
|
dropLocation |
string |
Drop Location for the test Run. |
dtlAutEnvironment |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
|
dtlEnvironment |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
|
dtlEnvironmentCreationDetails |
This is a temporary class to provide the details for the test run environment. |
|
dueDate |
string |
Due date and time for test run. |
errorMessage |
string |
Error message associated with the run. |
filter |
This class is used to provide the filters used for discovery |
|
id |
integer |
ID of the test run. |
incompleteTests |
integer |
Number of Incomplete Tests. |
isAutomated |
boolean |
true if test run is automated, false otherwise. |
iteration |
string |
The iteration to which the run belongs. |
lastUpdatedBy |
Team foundation ID of the last updated the test run. |
|
lastUpdatedDate |
string |
Last updated date and time |
name |
string |
Name of the test run. |
notApplicableTests |
integer |
Number of Not Applicable Tests. |
owner |
Team Foundation ID of the owner of the runs. |
|
passedTests |
integer |
Number of passed tests in the run |
phase |
string |
Phase/State for the testRun. |
pipelineReference |
Reference of the pipeline to which this test run belongs. |
|
plan |
Test plan associated with this test run. |
|
postProcessState |
string |
Post Process State. |
project |
Project associated with this run. |
|
release |
Release Reference for the Test Run. |
|
releaseEnvironmentUri |
string |
Release Environment Uri for TestRun. |
releaseUri |
string |
Release Uri for TestRun. |
revision |
integer |
|
runStatistics |
RunSummary by outcome. |
|
startedDate |
string |
Start date time of the run. |
state |
string |
The state of the run. Type TestRunState Valid states - Unspecified ,NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation |
substate |
TestRun Substate. |
|
tags |
Test |
Tags attached with this test run. |
testEnvironment |
Test environment associated with the run. |
|
testMessageLogId |
integer |
|
testSettings |
An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. |
|
totalTests |
integer |
Total tests in the run |
unanalyzedTests |
integer |
Number of failed tests in the run. |
url |
string |
Url of the test run |
webAccessUrl |
string |
Web Access Url for TestRun. |
TestRunSubstate
The types of sub states for test run.
Name | Type | Description |
---|---|---|
abortedBySystem |
string |
Run state when it is Aborted By the System. |
analyzed |
string |
Run state after being Analysed. |
canceledByUser |
string |
Run state while Creating Environment. |
cancellationInProgress |
string |
Run state when cancellation is in Progress. |
creatingEnvironment |
string |
Run state while Creating Environment. |
none |
string |
Run with noState. |
pendingAnalysis |
string |
Run state while Pending Analysis. |
runningTests |
string |
Run state while Running Tests. |
timedOut |
string |
Run state when run has timedOut. |
TestTag
Tag attached to a run or result.
Name | Type | Description |
---|---|---|
name |
string |
Name of the tag, alphanumeric value less than 30 chars |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for