Runs - Create
Create new test run.
POST https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=5.0
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 '5.0' to use this version of the api. |
Request Body
Name | Type | Description |
---|---|---|
automated |
boolean |
true if test run is automated, false otherwise. By default it will be false. |
build |
An abstracted reference to the build that it belongs. |
|
buildDropLocation |
string |
Drop location of the build used for test run. |
buildFlavor |
string |
Flavor of the build used for test run. (E.g: Release, Debug) |
buildPlatform |
string |
Platform of the build used for test run. (E.g.: x86, amd64) |
buildReference | ||
comment |
string |
Comments entered by those analyzing the run. |
completeDate |
string |
Completed date time of the run. |
configurationIds |
integer[] |
IDs of the test configurations associated with the run. |
controller |
string |
Name of the test controller used for automated run. |
customTestFields |
A custom field information. |
|
dtlAutEnvironment |
An abstracted reference to DtlAutEnvironment. |
|
dtlTestEnvironment |
An abstracted reference to DtlTestEnvironment. |
|
dueDate |
string |
Due date and time for test run. |
environmentDetails |
This is a temporary class to provide the details for the test run environment. |
|
errorMessage |
string |
Error message associated with the run. |
filter |
This class is used to provide the filters used for discovery |
|
iteration |
string |
The iteration in which to create the run. Root iteration of the team project will be default |
name |
string |
Name of the test run. |
owner |
Display name of the owner of the run. |
|
plan |
An abstracted reference to the plan that it belongs. |
|
pointIds |
integer[] |
IDs of the test points to use in the run. |
releaseEnvironmentUri |
string |
URI of release environment associated with the run. |
releaseReference |
Reference to a release. |
|
releaseUri |
string |
URI of release associated with the run. |
runTimeout |
string |
|
sourceWorkflow |
string |
|
startDate |
string |
Start date time of the run. |
state |
string |
The state of the run. Valid states - NotStarted, InProgress, Waiting |
testConfigurationsMapping |
string |
|
testEnvironmentId |
string |
ID of the test environment associated with the run. |
testSettings |
An abstracted reference to the test settings resource. |
|
type |
string |
Responses
Name | Type | Description |
---|---|---|
200 OK |
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_write | Grants the ability to read, create, and update test plans, cases, results and other test management related artifacts. |
Examples
Sample Request
POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs?api-version=5.0
{
"name": "NewTestRun",
"plan": {
"id": "1"
},
"pointIds": [
1,
1
]
}
Sample Response
{
"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
}
Definitions
Name | Description |
---|---|
Build |
|
Custom |
A custom field information. |
Dtl |
This is a temporary class to provide the details for the test run environment. |
Identity |
|
Reference |
The class to represent a collection of REST reference links. |
Release |
Reference to a release. |
Run |
Test run create details. |
Run |
This class is used to provide the filters used for discovery |
Run |
Test run statistics. |
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. |
Test |
|
Test |
|
Test |
Test run details. |
Test |
BuildConfiguration
Name | Type | Description |
---|---|---|
branchName |
string |
|
buildDefinitionId |
integer |
|
buildSystem |
string |
|
creationDate |
string |
|
flavor |
string |
|
id |
integer |
|
number |
string |
|
platform |
string |
|
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. |
|
repositoryGuid |
string |
|
repositoryType |
string |
|
sourceVersion |
string |
|
uri |
string |
CustomTestField
A custom field information.
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 |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. |
directoryAlias |
string |
|
displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
This url is the full route to the source resource of this graph subject. |
ReferenceLinks
The class to represent a collection of REST reference links.
Name | Type | Description |
---|---|---|
links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
ReleaseReference
Reference to a release.
Name | Type | Description |
---|---|---|
attempt |
integer |
|
creationDate |
string |
|
definitionId |
integer |
Release definition ID. |
environmentCreationDate |
string |
|
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. |
RunCreateModel
Test run create details.
Name | Type | Description |
---|---|---|
automated |
boolean |
true if test run is automated, false otherwise. By default it will be false. |
build |
An abstracted reference to the build that it belongs. |
|
buildDropLocation |
string |
Drop location of the build used for test run. |
buildFlavor |
string |
Flavor of the build used for test run. (E.g: Release, Debug) |
buildPlatform |
string |
Platform of the build used for test run. (E.g.: x86, amd64) |
buildReference | ||
comment |
string |
Comments entered by those analyzing the run. |
completeDate |
string |
Completed date time of the run. |
configurationIds |
integer[] |
IDs of the test configurations associated with the run. |
controller |
string |
Name of the test controller used for automated run. |
customTestFields |
A custom field information. |
|
dtlAutEnvironment |
An abstracted reference to DtlAutEnvironment. |
|
dtlTestEnvironment |
An abstracted reference to DtlTestEnvironment. |
|
dueDate |
string |
Due date and time for test run. |
environmentDetails |
This is a temporary class to provide the details for the test run environment. |
|
errorMessage |
string |
Error message associated with the run. |
filter |
This class is used to provide the filters used for discovery |
|
iteration |
string |
The iteration in which to create the run. Root iteration of the team project will be default |
name |
string |
Name of the test run. |
owner |
Display name of the owner of the run. |
|
plan |
An abstracted reference to the plan that it belongs. |
|
pointIds |
integer[] |
IDs of the test points to use in the run. |
releaseEnvironmentUri |
string |
URI of release environment associated with the run. |
releaseReference |
Reference to a release. |
|
releaseUri |
string |
URI of release associated with the run. |
runTimeout |
string |
|
sourceWorkflow |
string |
|
startDate |
string |
Start date time of the run. |
state |
string |
The state of the run. Valid states - NotStarted, InProgress, Waiting |
testConfigurationsMapping |
string |
|
testEnvironmentId |
string |
ID of the test environment associated with the run. |
testSettings |
An abstracted reference to the test settings resource. |
|
type |
string |
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.
Name | Type | Description |
---|---|---|
count |
integer |
|
outcome |
string |
Test run outcome |
resolutionState | ||
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 |
TestEnvironment
Name | Type | Description |
---|---|---|
environmentId |
string |
|
environmentName |
string |
TestResolutionState
Name | Type | Description |
---|---|---|
id |
integer |
|
name |
string |
|
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 |
|
createdDate |
string |
|
customFields |
A custom field information. |
|
dropLocation |
string |
|
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 |
|
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 |
|
owner |
Team Foundation ID of the owner of the runs. |
|
passedTests |
integer |
Number of passed tests in the run |
phase |
string |
|
plan |
Test plan associated with this test run. |
|
postProcessState |
string |
|
project |
Project associated with this run. |
|
release |
Reference to a release. |
|
releaseEnvironmentUri |
string |
|
releaseUri |
string |
|
revision |
integer |
|
runStatistics |
Test run statistics. |
|
startedDate |
string |
Start date time of the run. |
state |
string |
The state of the run. { NotStarted, InProgress, Waiting } |
substate | ||
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 |
|
url |
string |
Url of the test run |
webAccessUrl |
string |
TestRunSubstate
Name | Type | Description |
---|---|---|
abortedBySystem |
string |
|
analyzed |
string |
|
canceledByUser |
string |
|
cancellationInProgress |
string |
|
creatingEnvironment |
string |
|
none |
string |
|
pendingAnalysis |
string |
|
runningTests |
string |
|
timedOut |
string |
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